Javadoc html5 changes #1337
Javadoc html5 changes #1337
Conversation
| * <strike>{@link #setText(String)}</strike> and <strike>{@link #getText()}</strike>. | ||
| * If this field is used directly, then the user should use <ins>{@link #setSelectedValue(Object)}</ins> and | ||
| * <ins>{@link #getSelectedValue()}</ins> to get and set data on this field, rather than calling | ||
| * <del>{@link #setText(String)}</del> and <del>{@link #getText()}</del>. |
There was a problem hiding this comment.
I think the s tag is more correct? ins and del seem to be designed more for tracking changes.
There was a problem hiding this comment.
I was initially going to use <s> but thought the use of <ins> and <del> was more appropriate here as it is implying to use this rather than this
| * builder.setThreadPoolName("Thread Pool Name"); | ||
| * }<font color="blue"><b>builder.setListener(itemListener);</b></font>{@code | ||
| * }<span style="color:blue"><b>builder.setListener(itemListener);</b></span>{@code |
There was a problem hiding this comment.
These new spans need line breaks.
There was a problem hiding this comment.
I noticed that the {@literal } tags and the curly braces from the code were conflicting. This caused one of them to be interpreted literally. Was this the reason for the line breaks? With the soon incoming correction it appears identical to the docs released with 9.1.
| @@ -520,20 +520,20 @@ public static String formatNumber(long number, int radix) { | |||
| * <table><caption></caption> | |||
| * <tr><th>Number</th><th>Radix</th><th>DEFAULT Mode Alias</th><th><i>UNSIGNED</i> Mode Value</th><th><i>SIGNED</i> Mode Value</th></tr> | |||
| * <tr><td> </td><td></td><td><i></i></td><td></td><td></td></tr> | |||
| * <tr align=right><td>100</td><td>2</td><td><i>UNSIGNED</i></td><td>1100100b</td><td>1100100b</td></tr> | |||
There was a problem hiding this comment.
This table is not rendering correctly for me in my Eclipse hover feature. The headings don't line up with the columns.
There was a problem hiding this comment.
It appears there was a mistake here as it doesn't line up in the browser either. I'm looking into it now.
Was supposed to use text-align and not float
The Unsigned Mode Value header seems out of place. I'm going to see if it looks better with that cell header aligned differently.
There was a problem hiding this comment.
I've changed a few more things about the table such as aligning the above header and setting all the rows to monospace font so the numbers don't appear funny.
astrelsky
force-pushed
the
DocumentationFixes
branch
from
a0679e8 to
aa451d9
Compare
astrelsky
force-pushed
the
DocumentationFixes
branch
from
aa451d9 to
3bdf049
Compare
Ok no problem. Its just strange that it appears ok in the web browser. Also, I believe I've obtained the most important pr number for the rest of the history of this repository. |
|
Haha yes, I was gonna comment on the leetness of it! |
The following were the changes which were needed to be made to build the documentation in html5 (enforced on jdk 13.0.1). I will be attaching a prebuild archive of the javadocs in html5 along with a custom summary to allow easier visual comparison of the changes between the formats.
The only files which have been changed were ones where an error was reported while generating the documentation in html5.
Converted to CSS:
<font><align><center>Replaced with other tags/attributes:
<strike>to<del><tt>to<code>Table summary or caption is now required. However summary has been removed so an empty caption has been placed where needed and one summary was placed within the caption with its visibility set to hidden and font size set to zero to mirror the previous behavior (which did nothing).
api-html5.tar.gz
Extract the contents of the above archive into the docs folder of the ghidra installation or more likely into any directory with previously generated docs in an 'api' subfolder. Basically the structure needs to be:
I would also like to suggest setting
failOnError truein the createJavadocs task, but I haven't done so in this request.closes #1284