
<html>

<head>

<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">

<style type="text/css" style="display:none;"><!-- P {margin-top:0;margin-bottom:0;} --></style>

</head>

<body dir="ltr">

<div id="divtagdefaultwrapper" style="font-size:12pt;color:#000000;font-family:Calibri,Arial,Helvetica,sans-serif;">

<p><br>

</p>

Depends on previous patches as I'm not sure how to just create a single patch for that one file with Git. <br>

<br>

<div style="color: rgb(0, 0, 0);">

<div>

<hr style="display:inline-block; width:98%" tabindex="-1">

<div id="x_divRplyFwdMsg" dir="ltr"><font face="Calibri, sans-serif" color="#000000" style="font-size:11pt"><b>From:</b> devel <devel-bounces@libdivecomputer.org> on behalf of Jef Driesen <jef@libdivecomputer.org><br>

<b>Sent:</b> 08 November 2016 20:01<br>

<b>To:</b> Anton Lundin<br>

<b>Cc:</b> devel@libdivecomputer.org<br>

<b>Subject:</b> Re: Patches to add doxygen support to build and add some comments.</font>

<div> </div>

</div>

</div>

<font size="2"><span style="font-size:10pt;">

<div class="PlainText">On 08-11-16 20:48, Anton Lundin wrote:<br>

> On 08 November, 2016 - Jef Driesen wrote:<br>

><br>

>> On 07-11-16 13:05, Anton Lundin wrote:<br>

>>> On 04 November, 2016 - Ryan McLean wrote:<br>

>>>> |You also started to document some internal stuff. But none of that is<br>

>>>> |supposed to end up in the documentation! The part that needs to be<br>

>>>> |documented are the public header files.<br>

>>>><br>

>>>> I started there as I was trying to understand how libdivecomputer acutally works and<br>

>>>> figured all should be documented. I thought there would be two types of developers:<br>

>>>> 1) those using your public API such as subsurface<br>

>>>> 2) those wanting to contribute to libdivecomputer itself.<br>

>>>> Maybe should have two subfolders in the docs dir; public API and fulldoc.<br>

>>>><br>

>>><br>

>>> One can use the<br>

>>> <a href="http://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdinternal" id="LPlnk643811" previewremoved="true">

http://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdinternal</a> to<br>

>>> separate whats "internal" and whats external documentation.<br>

>>><br>

>>> That way one can "hide" internal api's when generating the "normal"<br>

>>> documentation, but still have them documented the same way, and include<br>

>>> them when generating the "internal" documentation for libdivecomputer.<br>

>><br>

>> It's even more simple: only the header files in the include<br>

>> directory are public, everything else is private.<br>

>><br>

><br>

> So you're saying there are no cases what so ever for documenting the<br>

> internal functions of libdivecomputer?<br>

<br>

Of course not. I'm just saying that the distinction between public and private <br>

can be based on the directory.<br>

<br>

Jef<br>

_______________________________________________<br>

devel mailing list<br>

devel@libdivecomputer.org<br>

<a href="http://libdivecomputer.org/cgi-bin/mailman/listinfo/devel" id="LPlnk723959" previewremoved="true">http://libdivecomputer.org/cgi-bin/mailman/listinfo/devel</a><br>

</div>

</span></font></div>

</div>

</body>

</html>