apidoc error/warning fix (#3) #5623
Conversation
mbien
left a comment
There was a problem hiding this comment.
looks good to me. great work eric!
| cp.<a href="ClassPath.html#addPropertyChangeListener-java.beans.PropertyChangeListener-"><font class="function-name">addPropertyChangeListener</font></a>(new <a href="@JDK@/java/beans/PropertyChangeListener.html"><font class="type">PropertyChangeListener</font></a>() { | ||
| <font class="keyword">public void</font> <font class="function-name">propertyChange</font>(<a href="@JDK@/java/beans/PropertyChangeEvent.html"><font class="type">PropertyChangeEvent</font></a> <font class="variable-name">evt</font>) { | ||
| <font class="keyword">if</font> (ClassPath.<a href="ClassPath.html#PROP_ROOTS"><font class="constant">PROP_ROOTS</font></a>.equals(evt.<a href="@JDK@/java/beans/PropertyChangeEvent.html#getPropertyName()"><font class="function-name">getPropertyName()</font></a>)) { | ||
| <font class="keyword">if</font> (ClassPath.<a href="ClassPath.html#PROP_ROOTS"><font class="constant">PROP_ROOTS</font></a>.equals(evt.<a href="@JDK@/java/beans/PropertyChangeEvent.html#getPropertyName--"><font class="function-name">getPropertyName()</font></a>)) { |
There was a problem hiding this comment.
just a question: what does the -- do? Couldn't find anything about it.
There was a problem hiding this comment.
it's a bit of anticipation for this one but the anchor in javadoc is changing parenthesis to -. So it will make an invalid link or link to the page instead of method.
The nbbuild javadoc checker detect this.
There was a problem hiding this comment.
ah. so its like a TODO for you? :)
There was a problem hiding this comment.
it's part of the phase 2.
Phase 1 is the clean up of javadoc itself to have no error and get all javadoc link ok (otherwise they need to move to our own management of modules/jdk links with replace.
Then in phase 2 the resulting checkstyle of apidoc need to be resolved to be sure to link to allowed url. each module have this check but in fact there is forward mention the only full apidoc check is important.
There was a problem hiding this comment.
like the marvel universe just with javadoc basically
There was a problem hiding this comment.
This is a third split of the big PR #4450.
using the following to have ant javadoc -Dmetabuild.branch=master -Dapidocfullcheck=true.
I will try to "rush" this part as it's now relaxed, to have a complete build and then do a second iteration to evaluate link as there is a lot of forward reference to no yet build apidoc.