Improve API documentation in raster.h and filter.h#123
Open
n0y0nD wants to merge 2 commits intoOpenPrinting:masterfrom
Open
Improve API documentation in raster.h and filter.h#123n0y0nD wants to merge 2 commits intoOpenPrinting:masterfrom
n0y0nD wants to merge 2 commits intoOpenPrinting:masterfrom
Conversation
| // | ||
| // System V interface script: | ||
| // https://www.ibm.com/docs/en/aix/7.2?topic=configuration-printer-interface-scripts | ||
|
|
Member
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. | ||
|
|
Member
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 |
Member
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... |
Member
There was a problem hiding this comment.
Do not remove "// Prototypes...".
Add an empty comment line before the comment you are adding here.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR improves and cleans up the public API documentation in
raster.h and filter.h.
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 .