Thread: [Doxygen-users] Comment block AFTER declaration in Fortran

Brought to you by: dimitri

doxygen-users

[Doxygen-users] Comment block AFTER declaration in Fortran

From: Petr P. <pet...@se...> - 2015-03-12 13:57:59

Hi,

how do I put the comment block after module/subroutine/function 
declaration in Fortran? I tried

      SUBROUTINE FOO
      !< description of FOO

but it does not work. For arguments and variables the "after" comment 
block works fine. I simply need to hide the bulky comment blocks inside 
subroutines to keep the code readable when collapsing the outlines in 
Visual Studio.

Thanks for any help,

Petr Parik

Re: [Doxygen-users] Comment block AFTER declaration in Fortran

From: Albert <alb...@gm...> - 2015-03-12 18:47:34

Dear Petr,

Currently there is no way to use the !< for the purpose you describe
(interesting thought though). As far as I know a !> block will work (in
most cases) provided it is not direct before an argument (as this will be
seen as documentation for the argument).

Albert

On Thu, Mar 12, 2015 at 2:57 PM, Petr Parik <pet...@se...> wrote:

> Hi,
>
> how do I put the comment block after module/subroutine/function
> declaration in Fortran? I tried
>
>       SUBROUTINE FOO
>       !< description of FOO
>
> but it does not work. For arguments and variables the "after" comment
> block works fine. I simply need to hide the bulky comment blocks inside
> subroutines to keep the code readable when collapsing the outlines in
> Visual Studio.
>
> Thanks for any help,
>
> Petr Parik
>
>
> ------------------------------------------------------------------------------
> Dive into the World of Parallel Programming The Go Parallel Website,
> sponsored
> by Intel and developed in partnership with Slashdot Media, is your hub for
> all
> things parallel software development, from weekly thought leadership blogs
> to
> news, videos, case studies, tutorials and more. Take a look and join the
> conversation now. http://goparallel.sourceforge.net/
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>

Re: [Doxygen-users] Comment block AFTER declaration in Fortran

From: Petr P. <pet...@se...> - 2015-03-12 21:00:27

Dear Albert,

thanks. I tried many ways in Doxygen 1.8.9.1 until I have found that the 
inside comment block works only if I put it AFTER any argument 
declarations (and use !>).

     SUBROUTINE FOO(BAR)
     IMPLICIT NONE
     INTEGER BAR
     !> description of FOO
     !> here it works!
     REAL A,B,C,D
     ! rest of the code
     END

This is not ideal but still better than putting the comment blocks 
before. Would it be possible to enhance !< to work after any declaration 
just like !> does before any declaration? That would be swell! :)

Best regards,

Petr

Dne 12.3.2015 v 19:47 Albert napsal(a):
> Dear Petr,
>
> Currently there is no way to use the !< for the purpose you describe 
> (interesting thought though). As far as I know a !> block will work 
> (in most cases) provided it is not direct before an argument (as this 
> will be seen as documentation for the argument).
>
> Albert
>
> On Thu, Mar 12, 2015 at 2:57 PM, Petr Parik <pet...@se... 
> <mailto:pet...@se...>> wrote:
>
>     Hi,
>
>     how do I put the comment block after module/subroutine/function
>     declaration in Fortran? I tried
>
>           SUBROUTINE FOO
>           !< description of FOO
>
>     but it does not work. For arguments and variables the "after" comment
>     block works fine. I simply need to hide the bulky comment blocks
>     inside
>     subroutines to keep the code readable when collapsing the outlines in
>     Visual Studio.
>
>     Thanks for any help,
>
>     Petr Parik
>
>     ------------------------------------------------------------------------------
>     Dive into the World of Parallel Programming The Go Parallel
>     Website, sponsored
>     by Intel and developed in partnership with Slashdot Media, is your
>     hub for all
>     things parallel software development, from weekly thought
>     leadership blogs to
>     news, videos, case studies, tutorials and more. Take a look and
>     join the
>     conversation now. http://goparallel.sourceforge.net/
>     _______________________________________________
>     Doxygen-users mailing list
>     Dox...@li...
>     <mailto:Dox...@li...>
>     https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>

Re: [Doxygen-users] Comment block AFTER declaration in Fortran

From: Fabian N. <fab...@sc...> - 2015-03-13 08:34:13

Hi all,

if I remember correctly, there's a possibility to put all the doxygen 
comment blocks for the subroutines in a separate file, isn't there?
Of course that would "hide" them statically, but you could still have a 
short description in-line if you like..

Just a thought...

Best regards,
Fabian.

* From: Petr Parik (pet...@se...)
* To: Fabian Nick (fab...@sc...)
* Sent:  12.03.2015 at 22:00 +0100
* Subject: Re: [Doxygen-users] Comment block AFTER declaration in Fortran
> Dear Albert,
>
> thanks. I tried many ways in Doxygen 1.8.9.1 until I have found that the
> inside comment block works only if I put it AFTER any argument
> declarations (and use !>).
>
>      SUBROUTINE FOO(BAR)
>      IMPLICIT NONE
>      INTEGER BAR
>      !> description of FOO
>      !> here it works!
>      REAL A,B,C,D
>      ! rest of the code
>      END
>
> This is not ideal but still better than putting the comment blocks
> before. Would it be possible to enhance !< to work after any declaration
> just like !> does before any declaration? That would be swell! :)
>
> Best regards,
>
> Petr
>
> Dne 12.3.2015 v 19:47 Albert napsal(a):
>> Dear Petr,
>>
>> Currently there is no way to use the !< for the purpose you describe
>> (interesting thought though). As far as I know a !> block will work
>> (in most cases) provided it is not direct before an argument (as this
>> will be seen as documentation for the argument).
>>
>> Albert
>>
>> On Thu, Mar 12, 2015 at 2:57 PM, Petr Parik <pet...@se...
>> <mailto:pet...@se...>> wrote:
>>
>>     Hi,
>>
>>     how do I put the comment block after module/subroutine/function
>>     declaration in Fortran? I tried
>>
>>           SUBROUTINE FOO
>>           !< description of FOO
>>
>>     but it does not work. For arguments and variables the "after" comment
>>     block works fine. I simply need to hide the bulky comment blocks
>>     inside
>>     subroutines to keep the code readable when collapsing the outlines in
>>     Visual Studio.
>>
>>     Thanks for any help,
>>
>>     Petr Parik
>>
>>     ------------------------------------------------------------------------------
>>     Dive into the World of Parallel Programming The Go Parallel
>>     Website, sponsored
>>     by Intel and developed in partnership with Slashdot Media, is your
>>     hub for all
>>     things parallel software development, from weekly thought
>>     leadership blogs to
>>     news, videos, case studies, tutorials and more. Take a look and
>>     join the
>>     conversation now. http://goparallel.sourceforge.net/
>>     _______________________________________________
>>     Doxygen-users mailing list
>>     Dox...@li...
>>     <mailto:Dox...@li...>
>>     https://lists.sourceforge.net/lists/listinfo/doxygen-users
>>
>>
>
>
>
> ------------------------------------------------------------------------------
> Dive into the World of Parallel Programming The Go Parallel Website, sponsored
> by Intel and developed in partnership with Slashdot Media, is your hub for all
> things parallel software development, from weekly thought leadership blogs to
> news, videos, case studies, tutorials and more. Take a look and join the
> conversation now. http://goparallel.sourceforge.net/
>
>
>
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>

Re: [Doxygen-users] Comment block AFTER declaration in Fortran

From: Fabian N. <fab...@sc...> - 2015-03-13 13:41:06

Hi Petr,

it looks like you only send your last mail to me, not the whole list. So I'm including it below.

The feature I was referring to in my last e-mail was this: http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html#structuralcommands

HTH,
Fabian.

On 13.03.2015 12:17, Petr Parik wrote:
> Hi all,
>
> if there's a possibility to put the comment blocks in a separate file
> (how? - I did not find it in docs), then there must be a way to connect
> the blocks with subroutine/function declarations, something like:
>
> !> @identifier FOO
> !> ....description....
>
> where the command @identifier says which subroutine I want to describe.
> Again, is this possible?
>
> -- 
> There is another setback to the solution I wrote earlier - I have found
> out that if I put the comment block inside a subroutine, no brief
> description is shown in the Functions/Subroutines index (detailed
> description below is ok). I tried to explicitly use @brief, but it is
> ignored.
>
> Best regards,
>
> Petr
>
> Dne 13.3.2015 v 9:21 Fabian Nick napsal(a):
> > Hi all,
> >
> > if I remember correctly, there's a possibility to put all the doxygen
> > comment blocks for the subroutines in a separate file, isn't there?
> > Of course that would "hide" them statically, but you could still have
> > a short description in-line if you like..
> >
> > Just a thought...
> >
> > Best regards,
> > Fabian.
> >
> > * From: Petr Parik (pet...@se...)
> > * To: Fabian Nick (fab...@sc...)
> > * Sent:  12.03.2015 at 22:00 +0100
> > * Subject: Re: [Doxygen-users] Comment block AFTER declaration in Fortran
> >> Dear Albert,
> >>
> >> thanks. I tried many ways in Doxygen 1.8.9.1 until I have found that the
> >> inside comment block works only if I put it AFTER any argument
> >> declarations (and use !>).
> >>
> >>      SUBROUTINE FOO(BAR)
> >>      IMPLICIT NONE
> >>      INTEGER BAR
> >>      !> description of FOO
> >>      !> here it works!
> >>      REAL A,B,C,D
> >>      ! rest of the code
> >>      END
> >>
> >> This is not ideal but still better than putting the comment blocks
> >> before. Would it be possible to enhance !< to work after any declaration
> >> just like !> does before any declaration? That would be swell! :)
> >>
> >> Best regards,
> >>
> >> Petr
> >>
> >> Dne 12.3.2015 v 19:47 Albert napsal(a):
> >>> Dear Petr,
> >>>
> >>> Currently there is no way to use the !< for the purpose you describe
> >>> (interesting thought though). As far as I know a !> block will work
> >>> (in most cases) provided it is not direct before an argument (as this
> >>> will be seen as documentation for the argument).
> >>>
> >>> Albert
> >>>
> >>> On Thu, Mar 12, 2015 at 2:57 PM, Petr Parik <pet...@se...
> >>> <mailto:pet...@se...>> wrote:
> >>>
> >>>     Hi,
> >>>
> >>>     how do I put the comment block after module/subroutine/function
> >>>     declaration in Fortran? I tried
> >>>
> >>>           SUBROUTINE FOO
> >>>           !< description of FOO
> >>>
> >>>     but it does not work. For arguments and variables the "after"
> >>> comment
> >>>     block works fine. I simply need to hide the bulky comment blocks
> >>>     inside
> >>>     subroutines to keep the code readable when collapsing the
> >>> outlines in
> >>>     Visual Studio.
> >>>
> >>>     Thanks for any help,
> >>>
> >>>     Petr Parik
> >>>
> >>> ------------------------------------------------------------------------------
> >>>
> >>>     Dive into the World of Parallel Programming The Go Parallel
> >>>     Website, sponsored
> >>>     by Intel and developed in partnership with Slashdot Media, is your
> >>>     hub for all
> >>>     things parallel software development, from weekly thought
> >>>     leadership blogs to
> >>>     news, videos, case studies, tutorials and more. Take a look and
> >>>     join the
> >>>     conversation now. http://goparallel.sourceforge.net/
> >>>     _______________________________________________
> >>>     Doxygen-users mailing list
> >>>     Dox...@li...
> >>>     <mailto:Dox...@li...>
> >>>     https://lists.sourceforge.net/lists/listinfo/doxygen-users
> >>>
> >>>
> >>
> >>
> >>
> >> ------------------------------------------------------------------------------
> >>
> >> Dive into the World of Parallel Programming The Go Parallel Website,
> >> sponsored
> >> by Intel and developed in partnership with Slashdot Media, is your
> >> hub for all
> >> things parallel software development, from weekly thought leadership
> >> blogs to
> >> news, videos, case studies, tutorials and more. Take a look and join the
> >> conversation now. http://goparallel.sourceforge.net/
> >>
> >>
> >>
> >> _______________________________________________
> >> Doxygen-users mailing list
> >> Dox...@li...
> >> https://lists.sourceforge.net/lists/listinfo/doxygen-users
> >>
>

[Doxygen-users] Fortran issues (reiterated)

From: Petr P. <pet...@se...> - 2015-03-19 10:42:03

Hi all,

let me reiterate on my two issues with Doxygen (1.8.9.1) and Fortran.

#1. Preserving name case -- I undestand the code change is not trivial. 
I have been able to partially resolve this by tweaking the HTML output 
with jQuery to uppercase what I need. But I still have to write #var or 
func() in lowercase (in comment blocks), because #VAR or FUNC() in 
uppercase does not create a valid link, which result in an 
inconsistency. I don't understand why function names are 
case-insensitive and references are not. Maybe changing the auto-linking 
to ignore the case would be better?

On the other hand, C and Java are both case-sensitive, so how come 
Doxygen does not keep the case in the first place? :)

#2. Documenting functions after declaration (inside function) -- I would 
like to put the whole comment block right after SUBROUTINE FOO(A,B,C) 
using !<. I have found that so far the only (unsatisfactory) working 
solution is to put a one-line comment !> *before* the declaration 
(serves as a brief description) and put the rest of the comment block !> 
inside the function *after* any function arguments. I tried to put the 
whole block inside and start it with !> @fn FOO(A,B,C) but that did not 
work. Is there a way to request this feature?

Best regards,

Petr