search

php / doc-en

English PHP documentation
504 stars 736 forks source link

Document missing classes #2162

Open kocsismate opened 1 year ago

kocsismate commented 1 year ago

Currently, the following internal classes are not yet documented:

The following internal classes are going to be undocumented as soon as PHP 8.4 is released:

cmb69 commented 1 year ago

Yay, com_safearray_proxy! I'll try to figure out its details.

Maybe @TimWolla wants to tackle SensitiveParameterValue?

TimWolla commented 1 year ago

Maybe @TimWolla wants to tackle SensitiveParameterValue?

I can write the description, but I need someone more experienced to bootstrap the docs for me. I've tried php doc-base/scripts/docgen/docgen.php -c SensitiveParameterValue, but that result is vastly incomplete (missing final on the class, missing properties, …).

kocsismate commented 1 year ago

@TimWolla as soon aa docgen created the file, you can run gen_stub.php on it (with --replace-classsynopses) and it will fix the signature.

TimWolla commented 1 year ago

I've tried php build/gen_stub.php --replace-classsynopses ../phpdoc/en/language/predefined/, but that did not do anything. Am I holding it wrong?

The docgen results are:

$ g d HEAD^..HEAD --stat
 language/predefined/interfaces.xml                        |  1 +
 language/predefined/sensitiveparametervalue.xml           | 65 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 language/predefined/sensitiveparametervalue/construct.xml | 69 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 language/predefined/sensitiveparametervalue/debuginfo.xml | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 language/predefined/sensitiveparametervalue/getvalue.xml  | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 language/predefined/versions.xml                          |  4 ++++
 6 files changed, 249 insertions(+)
kocsismate commented 1 year ago

@TimWolla yes, you are missing a parameter: after the --replace.... You need the stub path(s) in php-src. And the very last parameter is for the doc-en path.

TimWolla commented 1 year ago

Thanks, that did something.

haszi commented 10 months ago

Currently, the following internal classes are not yet documented:

  • [ ] LibXMLError

LibXMLError is already documented as libXMLError. Is that OK or should one of those be changed to match the spelling of the other?

Girgias commented 10 months ago

Currently, the following internal classes are not yet documented:

  • [ ] LibXMLError

LibXMLError is already documented as libXMLError. Is that OK or should one of those be changed to match the spelling of the other?

We should fix the name in the docs to match what the stubs is, which is LibXMLError

kocsismate commented 10 months ago

LibXMLError is already documented as libXMLError.

Thanks for the finding! I've just filed https://github.com/php/doc-en/pull/3063 to fix the issue with the spelling.

Girgias commented 10 months ago

All missing classes have been documented :fireworks:

kocsismate commented 10 months ago

Sorry, I have to reopen the issue as in the meanwhile (since PHP 8.2) a few other newly added classes became undocumented.

TimWolla commented 10 months ago

few other newly added classes became undocumented.

I would write the docs for IntervalBoundary, but that has the problem that it's the first native enum and I believe PHD cannot yet do enums.

kocsismate commented 10 months ago

I would write the docs for IntervalBoundary, but that has the problem that it's the first native enum and I believe PHD cannot yet do enums.

Uhh, that's a problem indeed. Then I'll try to implement it both at gen_stub.php's and phd's side...

Girgias commented 10 months ago

I would write the docs for IntervalBoundary, but that has the problem that it's the first native enum and I believe PHD cannot yet do enums.

Uhh, that's a problem indeed. Then I'll try to implement it both at gen_stub.php's and phd's side...

The issue is that we are using an outdated version of DocBooks, and the new enum synopsis tag is only available in the newest prerelease of Docbook 5.2.

When I get back to the UK next week I will try to finalize the migrations for the markup of classes in the current documentations so that one can update the DocBook version.

kocsismate commented 10 months ago

When I get back to the UK next week I will try to finalize the migrations for the markup of classes in the current documentations so that one can update the DocBook version.

Ah, I completely forgot that you have already been working on this topic. Then I'll leave it up to you to fix phd. :) And I can provide a PR for gen_stub.php if needed.

TimWolla commented 7 months ago

What's the status with enum rendering?

Girgias commented 7 months ago

I'm going to work on this again now, as I've given up on trying to not give huge amount of work to already über outdated translations.