rfc:doxygen
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
rfc:doxygen [2017/06/01 18:59] – fleshgrinder | rfc:doxygen [2017/09/22 13:28] (current) – external edit 127.0.0.1 | ||
---|---|---|---|
Line 3: | Line 3: | ||
* Date: 2017-05-30 | * Date: 2017-05-30 | ||
* Author: Richard Fussenegger, | * Author: Richard Fussenegger, | ||
- | * Status: | + | * Status: |
* First Published at: http:// | * First Published at: http:// | ||
Line 14: | Line 14: | ||
===== Proposal ===== | ===== Proposal ===== | ||
- | The proposal is actually very simple: to start documenting the C sources of PHP with Doxygen comments. This RFC will not go into detail why proper API documentation is beneficial, [[https:// | + | The proposal is actually very simple: to start documenting the C sources of PHP with Doxygen comments. This RFC will not go into detail why proper API documentation is beneficial, [[https:// |
This RFC does not propose any big documentation fest where development is halted and everybody starts writing documentation. Rather to start documenting in the future, as well as while refactoring or rewriting existing code. The target audience of our documentation should be fellow developers who want to get started with PHP internals development, | This RFC does not propose any big documentation fest where development is halted and everybody starts writing documentation. Rather to start documenting in the future, as well as while refactoring or rewriting existing code. The target audience of our documentation should be fellow developers who want to get started with PHP internals development, | ||
Line 87: | Line 87: | ||
PHPAPI const char *hello_world(char *arg1, char *arg2, int arg3, int arg4); | PHPAPI const char *hello_world(char *arg1, char *arg2, int arg3, int arg4); | ||
</ | </ | ||
+ | |||
+ | The following extended examples might be of interest too (they feature extensive documentation, | ||
+ | |||
+ | * [[https:// | ||
+ | * [[https:// | ||
===== Future Scope ===== | ===== Future Scope ===== | ||
Line 93: | Line 98: | ||
===== Proposed Voting Choices ===== | ===== Proposed Voting Choices ===== | ||
Simple 50%+1 majority vote. | Simple 50%+1 majority vote. | ||
+ | |||
+ | <doodle title=" | ||
+ | * Yes | ||
+ | * No | ||
+ | </ | ||
===== References ===== | ===== References ===== | ||
- | * [[http:// | + | |
+ | | ||
rfc/doxygen.1496343561.txt.gz · Last modified: 2017/09/22 13:28 (external edit)