Patches to add doxygen support to build and add some comments.
Jef Driesen
jef at libdivecomputer.org
Tue Nov 8 12:01:14 PST 2016
On 08-11-16 20:48, Anton Lundin wrote:
> On 08 November, 2016 - Jef Driesen wrote:
>
>> On 07-11-16 13:05, Anton Lundin wrote:
>>> On 04 November, 2016 - Ryan McLean wrote:
>>>> |You also started to document some internal stuff. But none of that is
>>>> |supposed to end up in the documentation! The part that needs to be
>>>> |documented are the public header files.
>>>>
>>>> I started there as I was trying to understand how libdivecomputer acutally works and
>>>> figured all should be documented. I thought there would be two types of developers:
>>>> 1) those using your public API such as subsurface
>>>> 2) those wanting to contribute to libdivecomputer itself.
>>>> Maybe should have two subfolders in the docs dir; public API and fulldoc.
>>>>
>>>
>>> One can use the
>>> http://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdinternal to
>>> separate whats "internal" and whats external documentation.
>>>
>>> That way one can "hide" internal api's when generating the "normal"
>>> documentation, but still have them documented the same way, and include
>>> them when generating the "internal" documentation for libdivecomputer.
>>
>> It's even more simple: only the header files in the include
>> directory are public, everything else is private.
>>
>
> So you're saying there are no cases what so ever for documenting the
> internal functions of libdivecomputer?
Of course not. I'm just saying that the distinction between public and private
can be based on the directory.
Jef
More information about the devel
mailing list