Skip to content
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

Merged
merged 2 commits into from
Oct 15, 2024

Conversation

nielsdos
Copy link
Member

Drive by fix in second commit too

@nielsdos
Copy link
Member Author

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... 🤷

@nielsdos nielsdos added this to the PHP 8.4 milestone Oct 15, 2024
Copy link
Member

@Girgias Girgias left a 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!

Comment on lines 35 to 37
<para>
<example>
<title><function>tidyNode::getNextSibling</function> example</title>
Copy link
Member

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.

Comment on lines 15 to 17
<para>
Returns the next sibling node of the current node.
</para>
Copy link
Member

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>
Copy link
Member

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>
Copy link
Member

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>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ditto simpara

Comment on lines 34 to 36
&reftitle.examples;
<para>
<example>
Copy link
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants