-
Notifications
You must be signed in to change notification settings - Fork 770
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Document tidyNode::getNextSibling() and tidyNode::getPreviousSibling() #3874
Conversation
I hope I did it right. It didn't generate the links locally for the "see also" section, but the existing "see also" sections also didn't have links locally so... 🤷 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor markup nits, but LGTM. Thank you!
<para> | ||
<example> | ||
<title><function>tidyNode::getNextSibling</function> example</title> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I know a lot of the documentation does this for reasons I don't know, but the wrapping <para>
tag around <example>
is useless.
<para> | ||
Returns the next sibling node of the current node. | ||
</para> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could be a <simpara>
|
||
<refsect1 role="returnvalues"> | ||
&reftitle.returnvalues; | ||
<para> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ditto could be simpara
<modifier>public</modifier> <type class="union"><type>tidyNode</type><type>null</type></type><methodname>tidyNode::getPreviousSibling</methodname> | ||
<void/> | ||
</methodsynopsis> | ||
<para> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ditto simpara
|
||
<refsect1 role="returnvalues"> | ||
&reftitle.returnvalues; | ||
<para> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ditto simpara
&reftitle.examples; | ||
<para> | ||
<example> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ditto useless para wrapping tag
Drive by fix in second commit too