Re: [Doxygen-users] Indenting comments

[Dimitri V. H. <do...@gm...>]

Hi Jim,

On Jul 27, 2010, at 15:31 , Jim Whitehouse wrote:
> Hello Martin,
> Thanks for those suggestions.
> 
> I'm sorry but I forgot to copy from my original posting that I am particularly interested in the pdf(LaTeX) output, and if I understand correctly, those instructions are specific to html.

No, you can use HTML-style markup in your comments also for PDF output. 
Doxygen will translate the markup commands to suitable LaTeX equivalents.

> 
> What  would be really useful (at least to me) would be something of the form:
> 
> //!4> My Doxy comment, indented by 4 spaces in the generated output document.
> 
> This would not unduly alarm "non Doxygen enabled" engineers who could read it as a standard comment, but would allow me to build a simple pseudo code description of an algorithm, line by line with the implementation.
> 
> Thanks again
> Jim
> 
> -----Original Message-----
> From: Martin K. Svensson [mailto:mar...@ne...] 
> Sent: 19 July 2010 12:35
> To: Jim Whitehouse
> Cc: Doxygen-users
> Subject: Re: [Doxygen-users] Indenting comments
> 
> How about <pre> or <ul> (or <ol>)?
> 
> -  
> Martin Svensson
> SW Developer
> 
> Net Insight AB | Box 42093 | SE-126 14 STOCKHOLM | SWEDEN
> Visiting address: Västberga Allé 9
> Direct: +46 (0)8 685 04 29 | Mobile: +46 (0)76 535 04 14
> Phone: +46 (0)8 685 04 00 | Fax: +46 (0)8 685 04 20
> Web: http://www.netinsight.net
> 
> 
> On Mon, 2010-07-19 at 12:23 +0100, Jim Whitehouse wrote:
>> Hi,
>> 
>> I have found it very useful to document certain functions step by
>> step, with inline comments.
>> 
>> e.g.
>> 
>> if(...)       /// If something
>> 
>> {
>> 
>>   ...        ///  then do something
>> 
>> }             /// Endif
>> 
>> It would be very nice to make the middle comment indent in the
>> documentation.
>> 
>> The only way I have found to do this is with the \arg command which
>> turns it into a bullet point. Is there a better way that I am missing?
>> 
>> I like the C# style /// comments here because they hardly show and
>> don't confuse non Doxygen enabled engineers too much. The comments
>> remain useful as code comments as well as for producing documentation.
>> A minimal syntax nestable way of adding indentation would be really
>> useful!
>> 
>> Thanks
>> 
>> Jim
>> 
>> ps. I previously submitted this as part of a list of minor problems,
>> but though it was probably better to submit them individually.
>> 
>> .
>> 
>> McMurdo Ltd. Silver Point, Airport Service Road, Portsmouth,
>> Hampshire, PO3 5PB, UK. 
>> Phone: +44 (0) 23 9262 3900 Fax : +44 (0) 23 9262 3998.
>> Registered in England No. 06952856 Registered Office: Silver Point,
>> Airport Service Road, Portsmouth, Hampshire, PO3 5PB. VAT NO GB 980
>> 2079 17
>> ------------------------------------------------------------------------------
>> This SF.net email is sponsored by Sprint
>> What will you do first with EVO, the first 4G phone?
>> Visit sprint.com/first -- http://p.sf.net/sfu/sprint-com-first
>> _______________________________________________ Doxygen-users mailing list Dox...@li... https://lists.sourceforge.net/lists/listinfo/doxygen-users.
> McMurdo Ltd.
> Silver Point, Airport Service Road, Portsmouth, Hampshire,  PO3 5PB, UK. 
> Phone: +44 (0) 23 9262 3900 Fax : +44 (0) 23 9262 3998.
> Registered in England No. 06952856 
> Registered Office: Silver Point, Airport Service Road, Portsmouth, Hampshire, PO3 5PB VAT NO GB 980 2079 17
> 
> 
> ------------------------------------------------------------------------------
> The Palm PDK Hot Apps Program offers developers who use the
> Plug-In Development Kit to bring their C/C++ apps to Palm for a share 
> of $1 Million in cash or HP Products. Visit us here for more details:
> http://ad.doubleclick.net/clk;226879339;13503038;l?
> http://clk.atdmt.com/CRS/go/247765532/direct/01/
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users