processing / processing/processing-website

Reference: Ability to overwrite @return

Abierto
#398 2 comentarios 0 reacciones 1 asignado Ver en GitHub

@scotthmurray ya está trabajando en esto.

Desde el 19/10/2015.

Enhancement
Lenguaje dominante
MDX
Estrellas
90
Forks
122
Merge medio
1 h 43 min
PR fusionados (30 d)
3

Descripción

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.

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.