[lttng-dev] How to document existing tracepoints (e.g. doxygen)

[Jan Blunck]

On Thu, Dec 13, 2012 at 12:46 PM, Mathieu Desnoyers
<mathieu.desnoyers at efficios.com> wrote:
> * Jan Blunck (jblunck at infradead.org) wrote:
>>
>> I tried to do that with doxygen but it did not work out of the box.
>> The target audience are sysadmins that should not or could not be
>> forced to read the source.
>
> I'd think that doxygen would be appropriate. What issues did you run
> into when trying going down that route ?
>

Doxygen was not able to parse through the macros correctly. Therefore
the output was not really what I would have expected. Anyway, I'll
continue to investigate how to tell doxygen to correctly parse this.

Thanks,
Jan


> Thanks,
>
> Mathieu
>
>>
>> Regards,
>> Jan
>>
>> _______________________________________________
>> lttng-dev mailing list
>> lttng-dev at lists.lttng.org
>> http://lists.lttng.org/cgi-bin/mailman/listinfo/lttng-dev
>
> --
> Mathieu Desnoyers
> Operating System Efficiency R&D Consultant
> EfficiOS Inc.
> http://www.efficios.com