Improve API documentation #123
Conversation
| // | ||
| // System V interface script: | ||
| // https://www.ibm.com/docs/en/aix/7.2?topic=configuration-printer-interface-scripts | ||
|
|
There was a problem hiding this comment.
This information is still relevant, please do not remove it.
You can move it to the comment block at the top of the function though.
| // rastertopwg. With Ghostscript supporting Apple Raster output | ||
| // (9.56.0 and newer), we actually produce Apple Raster and no further | ||
| // filter is required. | ||
|
|
There was a problem hiding this comment.
Please keep this "Note: ..." section. You can move it to the comment block at the top of the function.
| // actually produce if different from job's final output | ||
| // format, otherwise NULL to produce the job's final output | ||
| // format | ||
| // texttopdf_params: parameters for texttopdf |
There was a problem hiding this comment.
All this information is still relevant, please do not remove it.
You can move it to the comment block at the top of the function though.
|
|
||
|
|
||
| // | ||
| // Prototypes... |
There was a problem hiding this comment.
Do not remove "// Prototypes...".
Add an empty comment line before the comment you are adding here.
n0y0nD
changed the title
|
Priscill (@prisorue), this PR is ny volunteer contributor Nayanjyoti Das (@n0y0nD). Here you can see our libcupsfilters API documentation worked on and you can team up with Nayanjyoti, for example also reviewing his work, see how to proceed for API documentation and apply it to our other libraries, ... |
|
Thanks for the inline documentation work. Could you please not remove the longer, detailed comments which I have wrote up for some of the API functions. If they do not fit in for the automatic documentation generation, please put them into the manual part of the API documentation. Please also tell when you are so far ready for the PR being merged. Also the failing tests are not caused by your works. Other contributors are already working on them. |
2 participants
This PR improves and cleans up the public API documentation.
I reorganized and structured the documentation comments above
the relevant function prototypes, clarified parameter and return
descriptions, and made the formatting more consistent with the
documentation style used in CUPS.
This is part of the ongoing work for issue #54 .