Re: [pdf-devel] Extracting documentation from sources

[David Vazquez]

address@hidden writes:

> I would be happy to introduce the use of such a tool in GNU PDF but,
> due to the workflow we use (first design the API of the module and
> document it in the refman, then implement it) we really need to have
> some place to document the API before to write any code. If we can
> find a solution for this then to use a doxygen-like tool would be
> really useful. Any idea?
>

We could introduce a new special comment, like /* BEGIN PUBLIC */ and
/* END PUBLIC */. So it would be easier extract non-implemented
functions, or a (NON-IMPLEMENTED) in description field too. For
instance:

/* BEGIN NON-IMPLEMENTED */

/*
 * Description
 *
 * *Parameters*
 *
 * *Returns*
 *
 * *Usage example*
 *
 */

type
function (prototype)
{
}

/* END NON-IMPLEMENTED */