This also includes that libcupsfilters2 provides a new API which needs to get documented, to allow everyone to easily use the resources of this library which are the hard work of many people during the last 20+ years. Especially also the old libcupsfilters1 API did not get documented at all which makes the new one even more important to get documented.
At OpenPrinting we want to reach a common documentation standard on all our repositories. Example for this is our CUPS repository, where we have API documentation based on appropriately formatted comments in the C code (assembled by CodeDoc) plus manually created introduction and examples.
This we also want to do with the developer documentation of our other libraries, including libcupsfilters.
Most of the API functions and data types of libcupsfilters2 already have the comments needed for auto-generation of API documentation, but some can be missing and also some improvement here and there could be needed. We also need the manual part, introduction and examples to be written and everything assembled during the build process of the package.
This is a manual copy of libcupsfilters issue #54. As long as issues #70 and #71 are not solved this is the only way to go.
We have recently released the second generation of cups-filters which especially also contains the second generation of libcupsfilters (this repository).
This also includes that libcupsfilters2 provides a new API which needs to get documented, to allow everyone to easily use the resources of this library which are the hard work of many people during the last 20+ years. Especially also the old libcupsfilters1 API did not get documented at all which makes the new one even more important to get documented.
At OpenPrinting we want to reach a common documentation standard on all our repositories. Example for this is our CUPS repository, where we have API documentation based on appropriately formatted comments in the C code (assembled by CodeDoc) plus manually created introduction and examples.
This we also want to do with the developer documentation of our other libraries, including libcupsfilters.
Most of the API functions and data types of libcupsfilters2 already have the comments needed for auto-generation of API documentation, but some can be missing and also some improvement here and there could be needed. We also need the manual part, introduction and examples to be written and everything assembled during the build process of the package.
See also our talk about our documentation plans from our micro-conference on Linux Plumbers 2022: slides. video