Menu

#247 Generated JavaDoc is not formatted correctly

Short_term
open
5
2006-05-22
2006-04-26
Miro Halas
No

The JavaDoc included in our code doesn't contain
correct HTML formatting characters. This is causing it
appear all in one line in the generated documentation.
The JavaDoc especially for longer comments is then
unreadable.

We need to fix the build process to make sure that the
generated JavaDoc is correctly formatted.

Discussion

  • Miro Halas

    Miro Halas - 2006-04-26
    • status: open --> closed-fixed
     
  • Miro Halas

    Miro Halas - 2006-04-26

    Logged In: YES
    user_id=166079

    It is impossible to fix all the JavaDoc comments. Instead I
    have integrated wikidoclet to generate our javadoc
    documentation. This doclet accepts empty line as a paragraph
    separator.

    Unfortunately this doclet works only with JDK 1.4.2 and
    therefore this JDK is required to be present to generate
    JavaDoc. There is a new property in biuld.properties which
    needs to point to installed JDK 1.4.2

     
  • Miro Halas

    Miro Halas - 2006-04-26

    Logged In: YES
    user_id=166079

    the WikiDoclet didn't work correclty since it removed all
    the parameters. A different solution needs to be found.

     
  • Miro Halas

    Miro Halas - 2006-04-26
    • status: closed-fixed --> open
     
  • Miro Halas

    Miro Halas - 2006-05-22
    • summary: Generated JavaDoc is not formatter correctly --> Generated JavaDoc is not formatted correctly
     

Log in to post a comment.