Re: [Printing-architecture] OpenPrinting - Documentation urgently needed!

On 31/08/2023 18:12, Amin Bandali wrote:
> Hi Till, (all,)
> 
> I'm interested in helping out with the docs, particularly developer
> docs.  I recently asked my manager if I could spend some of my time
> helping with this, and essentially he said yes, depending on the
> workload and the priority of my other tasks at hand at a given time.
> Later on I hope to spend time on this outside work as well, as soon as
> my schedule opens up a bit more.
> 
> I'll start by taking some time to skim through the library functions
> for the libraries Till mentioned, and try to get a lay of the land.
> If folks have any suggestions or tips about which library and/or what
> modules specifically may be good places to start, I'd appreciate the
> advice.

Amin, we have 4 principal libraries which need developer documentation 
and you are highly welcome to work on that:

- libcupsfilters
- libppd
- cpdb-libs
- pappl-retrofit

Note that on Michael Sweet's projects (cups, libcups, pappl) Mike is 
already taking care of the documentation by himself.

To simplify our work at OpenPrinting we want to do all the documentation 
with the same tools, and as Michael has started with his codedoc tool on 
his own projects we want to adopt it for the rest of our libraries where 
I am leading the development.

See the sessions/slides of last year's OpenPrinting micro-conference 
which I have cited in my initial e-mail.

So your work would be:

1. Check the header and parameter comments of all API functions whethet 
they are actually there and also are in correct sysntax
2. Run the codedoc utility over the source code base and check whether 
everything appears correctly in the browser.
3. Add/complete the documentation which needs to be done manaually 
(Introduction, ...)

The priorities are:

1. cpdb-libs
    Needed for desktop integration. All print dialogs should use CPDB

2. libcupsfilters
    Needed for creation of printer and scanner drivers.

3. pappl-retrofit
    Needed for turning legacy CUPS printer drivers and SANE scanner
    drivers into Printer/Scanner Applications

4. libppd
    Usually used by pappl-retrofit and legacy CUPS filters (cups-filters)
    and not directly by developers, but for sake of completeness we
    should document it, too.

I hope this is sufficient info to get started. Do not hesitate to ask me 
if you have questions.

    Till