processing / processing/processing-website

Reference: Ability to overwrite @return

Open
#398 2 comments 0 reactions 1 assignee View on GitHub

@scotthmurray is already working on this.

Since Oct 19, 2015.

Enhancement
Dominant language
MDX
Stars
90
Forks
122
Avg merge
1h 43m
Merged PRs (30d)
3

Description

Hacking on the reference for processing-io I ran into two things that I couldn't get to work - and I think which might be limitations of the script that cranks out the reference. Posting them as separate issues for reference. Please feel free to close if this is known or very much the expected behavior. (And please tell me if there is a way to do it altogether!)

In Javadoc I sometimes use @return to describe the meaning of the return value. (E.g. that GPIO.digitalRead() returns either GPIO.HIGH or GPIO.LOW.) However the generated reference always just specifies the return type, which is perhaps not in all cases intuitive. I tried overwriting where it mattered in the XML files (setting <returns></returns>, which I found in the video library's files), but this didn't have an influence on the output either.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.