processing / processing/processing-website

Reference: Ability to overwrite @return

Aperta
#398 2 commenti 0 reazioni 1 assegnatario Vedi su GitHub

@scotthmurray ci sta già lavorando.

Dal 19/10/2015.

Enhancement
Lingua principale
MDX
Stelle
90
Fork
122
Merge medio
1h 43m
PR unite (30g)
3

Descrizione

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.

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.