Re: [Doxygen-users] Linking to functions with long parameter lists

[Daniel R. <dr...@ma...>]

Clemens Feige wrote:

> Hi Daniel.
> 
> You ask for a line-continuation feature in doxygen. 
> You mean something like the backslash for the C-preprocessor, don't 
> you?
> 
> Well, seems that nobody knows such feature for doxygen, including me.
> 
> But I have an idea that once again is based on regular expressions 
> (regex):
> 
> 1.
> Assuming that you have a very long line you want to break into 
> smaller ones, you write something like the following in your source 
> code:
> 
> first part         /*%*/ 
> second part   /*%*/
> third part       /*%*/
> 
> After each of those /*%*/ will be a new-line character.
> The /*%*/ is just a proposal, you can use whatever marker you want.
> 
> 2.
> You use a regex tool like SED together with the INPUT_FILTER option 
> of doxygen to search for   /*%*/+linebreak   and remove it including 
> the linebreak from the doxygen input. 
> Note that this regular expression filtering does not change your 
> source files.
> 
> 3.
> Doxygen should only see one big line. 
> 
> That's it. Theoretically. It is just an idea, I have not tested.

Clemens, that's just a _neat_ idea.
I wasn't aware of the INPUT_FILTER thing, never thinking I'd ever 
have to preprocess my sources with anything other than cpp.

Do you know when INPUT_FILTER is applied?  Before or after cpp?


> I have posted several messages this year, that deal about regular 
> expressions and the usage of the SED tool together with doxygen.
> 
> If you really want to dig into this, please let me hear whether it 
> works. Good luck.
> 
> Clemens
I'll give this a try shortly.

Thanks a lot, have fun
----Daniel



> On 8 Feb 2007 at 15:53, Daniel Rubin wrote:
> 
>> Hi list!
>>
>> (( First of all:  I'm new here so best of greetings to everyone! ))
>>
>> I have a question/problem with doxygen concerning links to C++ class
>> member functions with long parameter lists.  Linking to a specific
>> overloaded version works well as long as the whole reference, say
>>
>>     @see func(Type1 param1, ..., TypeN paramN)
>>
>> is placed on one line.  When it is split up on multiple lines, doxygen
>> obviously doesn't recognise it as function-with-parameter-list
>> reference any more, as it only uses the function name for the anchor
>> and unconditionally links to the first version of the overload or
>> doesn't link at all.
>>
>> Now I'd really like to wrap my doc comments to stay inside a
>> 80-character boundary, so is there some sort of line-continuation
>> support in doxygen or any other method to work around this limitation?
>>
>> Any pointers would be greatly appreciated.
>>
>> Have fun
>> ----Daniel
> 
> 
> -------------------------------------------------------------------------
> Take Surveys. Earn Cash. Influence the Future of IT
> Join SourceForge.net's Techsay panel and you'll get the chance to share your
> opinions on IT & business topics through brief surveys-and earn cash
> http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users