[prev in list] [next in list] [prev in thread] [next in thread]
List: doxygen-users
Subject: [Doxygen-users] detailed section with no comments?
From: Robb Surridge <Robb.Surridge () autodesk ! com>
Date: 2012-01-05 19:20:01
Message-ID: 90B881CD4B76614C89A206C4F5CC3DE907DAE6 () 005-TK5MPN1-013 ! MGDADSK ! autodesk ! com
[Download RAW message or body]
Hello,
I have a bunch of accessors and simple class functions that are defined inl=
ine.
The development manager doesn't want to have to bother to put doxygen comme=
nts for cases like these, because he feels that adding comments for simple =
cases makes redundant clutter in the headers. I still want the inline sourc=
e to get included in the doc, so that people can read the implementation an=
d follow the links to the other documented members in the code fragments.
So, I would like to force the generated documentation to put a "detailed" s=
ection for any function that has inline source code, even if that function =
has no doxygen comment block.
I can't figure out any way to get this to work. The best compromise I can c=
ome up with is to make a group that encloses the accessors, and use DISTRIB=
UTE_GROUP_DOC to assign a redundant comment like "Accessor function." to ev=
ery member in the group. But that's kind of ugly.
Any ideas?
[Attachment #3 (text/html)]
<html xmlns:v="urn:schemas-microsoft-com:vml" \
xmlns:o="urn:schemas-microsoft-com:office:office" \
xmlns:w="urn:schemas-microsoft-com:office:word" \
xmlns:m="http://schemas.microsoft.com/office/2004/12/omml" \
xmlns="http://www.w3.org/TR/REC-html40"> <head>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<meta name="Generator" content="Microsoft Word 12 (filtered medium)">
<style><!--
/* Font Definitions */
@font-face
{font-family:"Cambria Math";
panose-1:2 4 5 3 5 4 6 3 2 4;}
@font-face
{font-family:Calibri;
panose-1:2 15 5 2 2 2 4 3 2 4;}
@font-face
{font-family:Tahoma;
panose-1:2 11 6 4 3 5 4 4 2 4;}
/* Style Definitions */
p.MsoNormal, li.MsoNormal, div.MsoNormal
{margin:0in;
margin-bottom:.0001pt;
font-size:11.0pt;
font-family:"Calibri","sans-serif";}
a:link, span.MsoHyperlink
{mso-style-priority:99;
color:blue;
text-decoration:underline;}
a:visited, span.MsoHyperlinkFollowed
{mso-style-priority:99;
color:purple;
text-decoration:underline;}
p.MsoAcetate, li.MsoAcetate, div.MsoAcetate
{mso-style-priority:99;
mso-style-link:"Balloon Text Char";
margin:0in;
margin-bottom:.0001pt;
font-size:8.0pt;
font-family:"Tahoma","sans-serif";}
span.EmailStyle17
{mso-style-type:personal-compose;
font-family:"Calibri","sans-serif";
color:windowtext;}
span.BalloonTextChar
{mso-style-name:"Balloon Text Char";
mso-style-priority:99;
mso-style-link:"Balloon Text";
font-family:"Tahoma","sans-serif";}
.MsoChpDefault
{mso-style-type:export-only;}
@page WordSection1
{size:8.5in 11.0in;
margin:1.0in 1.0in 1.0in 1.0in;}
div.WordSection1
{page:WordSection1;}
--></style><!--[if gte mso 9]><xml>
<o:shapedefaults v:ext="edit" spidmax="1026" />
</xml><![endif]--><!--[if gte mso 9]><xml>
<o:shapelayout v:ext="edit">
<o:idmap v:ext="edit" data="1" />
</o:shapelayout></xml><![endif]-->
</head>
<body lang="EN-US" link="blue" vlink="purple">
<div class="WordSection1">
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">Hello,<o:p></o:p></p>
<p class="MsoNormal">I have a bunch of accessors and simple class functions that are \
defined inline.<o:p></o:p></p> <p class="MsoNormal">The development manager doesn't \
want to have to bother to put doxygen comments for cases like these, because he feels \
that adding comments for simple cases makes redundant clutter in the headers. I still \
want the inline source to get included in the doc, so that people can read the \
implementation and follow the links to the other documented members in the code \
fragments.<o:p></o:p></p> <p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">So, I would like to force the generated documentation to put a \
"detailed" section for any function that has inline source code, even if \
that function has no doxygen comment block. <o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">I can't figure out any way to get this to work. The best \
compromise I can come up with is to make a group that encloses the accessors, and use \
DISTRIBUTE_GROUP_DOC to assign a redundant comment like "Accessor \
function." to every member in the group. But that's kind of \
ugly.<o:p></o:p></p> <p class="MsoNormal">Any ideas?<o:p></o:p></p>
</div>
</body>
</html>
[Attachment #4 (--===============2102076989564886089==)]
------------------------------------------------------------------------------
Ridiculously easy VDI. With Citrix VDI-in-a-Box, you don't need a complex
infrastructure or vast IT resources to deliver seamless, secure access to
virtual desktops. With this all-in-one solution, easily deploy virtual
desktops for less than the cost of PCs and save 60% on VDI infrastructure
costs. Try it free! http://p.sf.net/sfu/Citrix-VDIinabox
_______________________________________________
Doxygen-users mailing list
Doxygen-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic