Re: [Doxygen-users] Linking to functions with long parameter lists
Brought to you by:
dimitri
From: Clemens F. <c....@os...> - 2007-02-16 17:04:36
|
Hi again, Daniel. Congratulations. This is very cool. Generally I also prefer PERL. The only reason for why I have choosen SED is that I deliver the SED binary and the doxygen binary together with my source code. A explicite installation of perl and/or doxygen is not required. greetings Clemens On 16 Feb 2007 at 17:20, Daniel Rubin wrote: > I have successfully applied your suggestion, but using perl > instead of sed (handling newlines in sed always freaks me a little). > > Here's my prefilter.pl script: > ------------------------------------------------------------ > > #!/usr/bin/perl > > $/ = undef; > $_ = <>; > s%\s*//\n\s*\**\s*% %gs; > print; > > ------------------------------------------------------------ > As you can see, I'm using a double slash "//" at the end of the > line as continuation mark (because of the nice correspondence to > poetry plus it shouldn't get in the way of anything else, being a > comment-opener itself). > > Any whitespace around this mark and any number of leading > asterisks on the appended line is removed too. In the example I gave > in the original post, I can now write > /** > ** But see overloaded(int a, int b, int c, int d, int e, // ** > int f, int g, int h, int i, int j, int k) for a more ** > elaborate version. */ > and get a link to the doc of the right method (tested). > > So far, so good. Thanks a lot, Clemens! > > I will look to a more elaborate version of this in the next days. > Because this one has a flaw: If ever I edit a doc comment > containing such a long reference and it gets re-filled, I'll have the > correct the placement of the continuation marks. > > Maybe it would be best to join all lines in a paragraph without > regard to a continuation mark. This way, we wouldn't need it at all. > > Got to ponder this a little. > > Thanks again, and have fun > ----Daniel > |