Skip to content

Various fixes for even more interfaces #2560

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.

Sign up for GitHub

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

Closed
mallardduck wants to merge 4 commits into from
Closed

Various fixes for even more interfaces #2560

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
44665eb
Adjust other interfaces to have class set
mallardduck Jun 29, 2023
27a4ee8
Adjust commonmark modifiers
mallardduck Jul 5, 2023
8f966e8
Revert mongodb changes as I'm not familiar with those
mallardduck Jul 5, 2023
31efda3
Fix predefined interfaces - add back missing space
mallardduck Jul 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions language/predefined/backedenum.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,7 @@
</ooclass>

<classsynopsisinfo>
<oointerface>
<interfacename>BackedEnum</interfacename>
</oointerface>
<ooclass><classname>BackedEnum</classname></ooclass>
Copy link
Copy Markdown
Member

@kocsismate kocsismate Jul 7, 2023

Choose a reason for hiding this comment

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

Please do not do commit this change on its own since it's contrary to the output of gen_stub.php (the script which generates these markups). Please rather fix the script itself.

Copy link
Copy Markdown
Contributor Author

@mallardduck mallardduck Jul 7, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

@kocsismate Are there any docs or wiki pages somewhere detailing how to work with the gen_stub.php script? I have ran it before in the past on php-src but am not sure how I would run that script for the extensions? Oh my fault - for some reason I forgot this PR was attempting to fix both extension refs and language docs.


<oointerface>
<interfacename>UnitEnum</interfacename>
Expand Down
4 changes: 1 addition & 3 deletions language/predefined/iterator.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,7 @@
</ooclass>

<classsynopsisinfo>
<oointerface>
<interfacename>Iterator</interfacename>
</oointerface>
<ooclass><classname>Iterator</classname></ooclass>

<oointerface>
<interfacename>Traversable</interfacename>
Expand Down
4 changes: 1 addition & 3 deletions language/predefined/iteratoraggregate.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,7 @@
</ooclass>

<classsynopsisinfo>
<oointerface>
<interfacename>IteratorAggregate</interfacename>
</oointerface>
<ooclass><classname>IteratorAggregate</classname></ooclass>

<oointerface>
<interfacename>Traversable</interfacename>
Expand Down
4 changes: 1 addition & 3 deletions language/predefined/throwable.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,7 @@
</ooclass>

<classsynopsisinfo>
Copy link
Copy Markdown
Member

@Girgias Girgias Jul 5, 2023

Choose a reason for hiding this comment

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

Suggested change
<classsynopsisinfo>
<classsynopsis class="interface">

Isn't this missing, or am I not understanding how the new markup should look?

Copy link
Copy Markdown
Contributor Author

@mallardduck mallardduck Jul 5, 2023

Choose a reason for hiding this comment

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

So for the new markup generation to kick in, we want it to call format_classsynopsisinfo_ooclass_classname - which means we need a ooclass inside of a classsynopsisinfo.

Then once that's being called we also need the class attr set to interface - which changes the render from calling it a class to use interface. Similarly, when that attr is set this way the oointerface that's being extended/implemented will adjust for the correct verb.

Copy link
Copy Markdown
Member

@Girgias Girgias Jul 5, 2023

Choose a reason for hiding this comment

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

Okay, I'm going to group thoughts in the issues I opened to try and centralise stuff instead of me commenting left and right.

<oointerface>
<interfacename>Throwable</interfacename>
</oointerface>
<ooclass><classname>Throwable</classname></ooclass>

<oointerface>
<interfacename>Stringable</interfacename>
Expand Down
2 changes: 1 addition & 1 deletion reference/cmark/commonmark.interfaces.ivisitable.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
&reftitle.classsynopsis;

<!-- {{{ Synopsis -->
<classsynopsis>
<classsynopsis class="interface">
<ooclass><classname>CommonMark\Interfaces\IVisitable</classname></ooclass>

<!-- {{{ Class synopsis -->
Expand Down
2 changes: 1 addition & 1 deletion reference/cmark/commonmark.interfaces.ivisitor.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
&reftitle.classsynopsis;

<!-- {{{ Synopsis -->
<classsynopsis>
<classsynopsis class="interface">
<ooclass><classname>CommonMark\Interfaces\IVisitor</classname></ooclass>

<!-- {{{ Class synopsis -->
Expand Down
2 changes: 1 addition & 1 deletion reference/cmark/commonmark/interfaces/ivisitable/accept.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>abstract</modifier> <modifier>public</modifier> <type>void</type><methodname>CommonMark\Interfaces\IVisitable::accept</methodname>
<modifier>public</modifier> <type>void</type><methodname>CommonMark\Interfaces\IVisitable::accept</methodname>
<methodparam><type>CommonMark\Interfaces\IVisitor</type><parameter>visitor</parameter></methodparam>
</methodsynopsis>

Expand Down
2 changes: 1 addition & 1 deletion reference/cmark/commonmark/interfaces/ivisitor/enter.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>abstract</modifier> <modifier>public</modifier> <type class="union"><type>int</type><type>IVisitable</type><type>null</type></type><methodname>CommonMark\Interfaces\IVisitor::enter</methodname>
<modifier>public</modifier> <type class="union"><type>int</type><type>IVisitable</type><type>null</type></type><methodname>CommonMark\Interfaces\IVisitor::enter</methodname>
<methodparam><type>IVisitable</type><parameter>visitable</parameter></methodparam>
</methodsynopsis>

Expand Down
2 changes: 1 addition & 1 deletion reference/cmark/commonmark/interfaces/ivisitor/leave.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>abstract</modifier> <modifier>public</modifier> <type class="union"><type>int</type><type>IVisitable</type><type>null</type></type><methodname>CommonMark\Interfaces\IVisitor::leave</methodname>
<modifier>public</modifier> <type class="union"><type>int</type><type>IVisitable</type><type>null</type></type><methodname>CommonMark\Interfaces\IVisitor::leave</methodname>
<methodparam><type>IVisitable</type><parameter>visitable</parameter></methodparam>
</methodsynopsis>

Expand Down
2 changes: 1 addition & 1 deletion reference/json/jsonserializable.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
&reftitle.interfacesynopsis;

<!-- {{{ Synopsis -->
<classsynopsis>
<classsynopsis class="interface">
<ooclass>
<classname>JsonSerializable</classname>
</ooclass>
Expand Down
2 changes: 1 addition & 1 deletion reference/pthreads/collectable.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
&reftitle.interfacesynopsis;

<!-- {{{ Synopsis -->
<classsynopsis>
<classsynopsis class="interface">
<ooclass><classname>Collectable</classname></ooclass>

<!-- {{{ Class synopsis -->
Expand Down