Skip to content

Fix error messages from Javadocs#4191

Merged
benfry merged 1 commit into
processing:masterfrom
GKFX:javadocs
May 10, 2016
Merged

Fix error messages from Javadocs#4191
benfry merged 1 commit into
processing:masterfrom
GKFX:javadocs

Conversation

@GKFX

@GKFX GKFX commented Dec 6, 2015

Copy link
Copy Markdown
Contributor

I'm trying to significantly reduce the number of error messages from the ant doc command, so that the genuine errors can be seen and dealt with. Currently, for example, there's an unclosed bold tag over a lot of an online Javadoc page. (It seems to have been fixed in the original files now though.)

This isn't finished yet; I'd like some advice. This first commit was just running GenerateDescriptions.py with some patching/manual editing of files where it was broken. This was so that if I needed to modify and rerun the script or XMLs later, the later commits' diffs wouldn't contain ordinary updates to XML files.

The second commit fixes most of the errors except those in the HTML and syntax categories of Javadoc's Doc-lint tool, and suppresses the production of those messages by the Javadoc tool. It also makes the @usage and @brief tags display in the proper Javadoc, since that was an option I had when stopping them from being errors; I can hide them if preferred.

This just leaves the syntax errors. As far as I can tell, there's no way to stop Javadoc moaning about <br /> but keep getting the useful messages about unclosed tags and other real errors. And there are loads of messages about <br />, making Javadoc's output almost unreadable if you don't suppress them. So: can I

  • modify all the XML files to make them say <br> as preferred?
  • modify the script to convert <br /> to <br>?
  • or just leave it alone and keep all syntax errors suppressed?

I'm asking because I don't know what else uses those files and how strict their XML needs to be. I'd also need to wrap code samples in the XMLs in {@code } tags where they contain angle brackets (which escapes them) to avoid filling the doc comments in the .java files with &lt;&lt;=; can all other users of the XML files handle that sort of Javadoc syntax?

@benfry

benfry commented Feb 13, 2016

Copy link
Copy Markdown
Contributor

If you'll remove the 'regenerate javadocs' commit from this PR, then I can merge it. The other stuff might be fine, but re-running those scripts needs to be handled by @REAS, so that's something we should coordinate separately with him.

@GKFX

GKFX commented Feb 17, 2016

Copy link
Copy Markdown
Contributor Author

Okay, I've done that.

@REAS

REAS commented Feb 17, 2016

Copy link
Copy Markdown
Member

@GKFX All of the
in the XML files are
to work with the system, but nothing has been automated. We've put so much time and energy into getting this to work over the years, but as you've seen it's not finished.

@benfry

benfry commented May 8, 2016

Copy link
Copy Markdown
Contributor

@GKFX Thanks for your follow-up. Can you redo your branch so that it no longer has conflicts? Sorry to have missed the window to get it merged earlier.

@GKFX GKFX force-pushed the javadocs branch 2 times, most recently from 5e86224 to f8f14eb Compare May 10, 2016 17:59
@GKFX

GKFX commented May 10, 2016

Copy link
Copy Markdown
Contributor Author

@benfry I've rebased it.

@benfry benfry merged commit eb0429a into processing:master May 10, 2016
@benfry

benfry commented May 10, 2016

Copy link
Copy Markdown
Contributor

Thanks again!

@benfry

benfry commented May 10, 2016

Copy link
Copy Markdown
Contributor

Merged for 3.1.1, fixes #1492

@GKFX GKFX deleted the javadocs branch August 29, 2017 18:13
@github-actions

Copy link
Copy Markdown

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions Bot locked as resolved and limited conversation to collaborators Jun 15, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants