On 23/01/2013 12:22, Smith, Lee wrote:
> Hi,
>
> Does doxygen support Fortran generic interfaces?
>
> I have tested the following file using 1.8.3.1 but the documentation
> produced is not really correct.
>
> I would expect just two documented subroutines, both called sub.
>
Well, I would say it is supported exactly the way you showed: you have
an entry corresponding to the generic interface sub pointing to the
interface description page, which in turn links to the description of
the n specific interfaced implementations; separately, in the
function/subroutine section, you have the entries with the specific
names in a C++ style, not the generic name; the last ones disappear if
you declare the specific names as PRIVATE (but PUBLIC/PRIVATE are not
always correctly interpreted by doxygen), so that the specific
descriptions can only be reached through the interface link in that
case, and in my opinion this is the right thing to do in order to avoid
duplications in the documentation.
I would say this type of formatting was the choice of the author of the
fortran interpreter + constraints given by the overall Doxygen
structure. I personally like it, although I agree that it requires from
the user a knowledge of what a generic interface is, plus some intuition
to understand that under "data types" you actually find executable code;
in other words a f77 programmer would feel themself disoriented in such
a page...
Best regards, Davide
>> \addtogroup test
>
> !! Testing
>
> !!@{
>
> !>
>
> !! Generic interface
>
> interface sub
>
> !>
>
> !! Integer
>
> !!
>
> !! \param[in] i Integer value
>
> subroutine sub_i (i)
>
> integer, intent(in) :: i
>
> end subroutine sub_i
>
> !>
>
> !! Real
>
> !!
>
> !! \param[in] r Real value
>
> subroutine sub_r (r)
>
> real, intent(in) :: r
>
> end subroutine sub_r
>
> end interface sub
>
> !>@}
>
> Here is the produced documentation.
>
> Thanks for any guidance on this.
>
> Regards,
>
> Lee
>
--
============================= Davide Cesari ============================
Servizio IdroMeteoClima - ARPA Emilia Romagna
NWP modelling - Modellistica numerica previsionale
Phone/Fax: +39 051525926/+39 0516497501
E-mail: dces...@arpa.emr.it
Home page: http://www.webalice.it/o.drofa/davide/
Address: ARPA-SIM, Viale Silvani 6, 40122 Bologna, Italy
========================================================================
------------------------------------------------------------------------------
Master Visual Studio, SharePoint, SQL, ASP.NET, C# 2012, HTML5, CSS,
MVC, Windows 8 Apps, JavaScript and much more. Keep your skills current
with LearnDevNow - 3,200 step-by-step video tutorials by Microsoft
MVPs and experts. ON SALE this month only -- learn more at:
http://p.sf.net/sfu/learnnow-d2d
_______________________________________________
Doxygen-users mailing list
Doxygen-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users
