You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@openoffice.apache.org by Patricia Shanahan <pa...@acm.org> on 2016/02/23 18:55:29 UTC
[DISCUSS] Documentation comments
Does the AOO source code have any documentation comments? If so, what
package is used?
If not, I would like to propose selecting a package. I am getting into
reading some of the code, and would like to record my conclusions in
place, in a form that can be extracted and turned into HTML or similar.
Doxygen, http://www.stack.nl/~dimitri/doxygen/index.html, is an example.
Patricia
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@openoffice.apache.org
For additional commands, e-mail: dev-help@openoffice.apache.org
Re: [DISCUSS] Documentation comments
Posted by Kay Schenk <ka...@gmail.com>.
On 02/23/2016 12:56 PM, Dennis E. Hamilton wrote:
> The answer appears to be "yes and no".
>
> This page is the top level of some considerable in-code format
> and documentation practices:
> <https://wiki.openoffice.org/wiki/Cpp_Coding_Standards>. (Hat
> tip to j.nitschke for pointing me to these.)
>
> Documentation codes are treated at
> <https://wiki.openoffice.org/wiki/Cpp_Coding_Standards/CODEDOC>.
>
>
> This material was last updated in 2007.
>
> It seems that the AutoDoc only ran on header files.
>
> The clarifying function behavior (ClearBehave) topic is something
> I found a need for in handling some problems with use-after-free,
> null pointer dereference issues, and .
>
> Short-term, I suggest we use these, assuming they already exist
> in the current code base. Then it is all consistent even if
> possibly using an outmoded system.
A short addendum to Dennis's reply.
The starting wiki page on this is:
https://wiki.openoffice.org/wiki/Autodoc
We have an autodoc directory under /main in our source tree.
I would need to do another build to see how this is used.
>> -----Original Message----- From: Patricia Shanahan
>> [mailto:pats@acm.org] Sent: Tuesday, February 23, 2016 09:55
>> To: dev@openoffice.apache.org Subject: [DISCUSS] Documentation
>> comments
>>
>> Does the AOO source code have any documentation comments? If
>> so, what package is used?
>>
>> If not, I would like to propose selecting a package. I am
>> getting into reading some of the code, and would like to record
>> my conclusions in place, in a form that can be extracted and
>> turned into HTML or similar.
>>
>> Doxygen, http://www.stack.nl/~dimitri/doxygen/index.html, is an
>> example.
>>
>> Patricia
>>
>> ---------------------------------------------------------------------
>>
>>
To unsubscribe, e-mail: dev-unsubscribe@openoffice.apache.org
>> For additional commands, e-mail:
>> dev-help@openoffice.apache.org
>
>
> ---------------------------------------------------------------------
>
>
To unsubscribe, e-mail: dev-unsubscribe@openoffice.apache.org
> For additional commands, e-mail: dev-help@openoffice.apache.org
>
--
--------------------------------------------
MzK
"Though no one can go back and make a brand new start,
anyone can start from now and make a brand new ending."
-- Carl Bard
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@openoffice.apache.org
For additional commands, e-mail: dev-help@openoffice.apache.org
RE: [DISCUSS] Documentation comments
Posted by "Dennis E. Hamilton" <de...@acm.org>.
The answer appears to be "yes and no".
This page is the top level of some considerable in-code format and documentation practices: <https://wiki.openoffice.org/wiki/Cpp_Coding_Standards>. (Hat tip to j.nitschke for pointing me to these.)
Documentation codes are treated at <https://wiki.openoffice.org/wiki/Cpp_Coding_Standards/CODEDOC>.
This material was last updated in 2007.
It seems that the AutoDoc only ran on header files.
The clarifying function behavior (ClearBehave) topic is something I found a need for in handling some problems with use-after-free, null pointer dereference issues, and .
Short-term, I suggest we use these, assuming they already exist in the current code base. Then it is all consistent even if possibly using an outmoded system.
> -----Original Message-----
> From: Patricia Shanahan [mailto:pats@acm.org]
> Sent: Tuesday, February 23, 2016 09:55
> To: dev@openoffice.apache.org
> Subject: [DISCUSS] Documentation comments
>
> Does the AOO source code have any documentation comments? If so, what
> package is used?
>
> If not, I would like to propose selecting a package. I am getting into
> reading some of the code, and would like to record my conclusions in
> place, in a form that can be extracted and turned into HTML or similar.
>
> Doxygen, http://www.stack.nl/~dimitri/doxygen/index.html, is an example.
>
> Patricia
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@openoffice.apache.org
> For additional commands, e-mail: dev-help@openoffice.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@openoffice.apache.org
For additional commands, e-mail: dev-help@openoffice.apache.org