Improvement for fortranscanner
Davide Cesari <[email protected]>
| Newsgroups | gmane.text.doxygen.devel,gmane.text.doxygen.general |
|---|---|
| Message-ID | <[email protected]> |
Dear doxygen developers, I have a simple suggestion for improvement in
fortranscanner.l:
=== cut here ===
--- ./src/fortranscanner.l~ 2010-03-14 16:26:58.000000000 +0100
+++ ./src/fortranscanner.l 2010-08-17 12:17:27.000000000 +0200
@@ -1089,6 +1089,8 @@
dest->bodyLine = src->bodyLine;
dest->args = src->args;
dest->argList = new ArgumentList(*src->argList);
+ dest->doc = src->doc;
+ dest->brief = src->brief;
}
/** fill empty interface module procedures with info from
=== cut here ===
this ensures that, in case of MODULE PROCEDUREs belonging to an
INTERFACE, the procedure documentation which is reached navigating from
the interface link is as complete as the stand-alone documentation of
the procedure itself, while now the first one does not contain the brief
and long documentation text; I do not know whether it is so by design or
because it was overlooked, I will give a longer explanation of why this
modification is desirable IMHO. If you think this is reasonable and
error-free, it would be nice to have it updated in svn.
Longer and boring Fortran explanation: if a programmer defines a generic
interface to one or mode module procedures, it means that they would
like people to use the generic interfaced name, not the specific name,
so the biggest emphasis should be given to the documentation that
appears through the interface, not to the documentation that is reached
by directly clicking on the stand-alone function/subroutine link. Even
more, I think that, at least under the control of a configuration
switch, the documented module procedures which are member of an
interface should be removed from the function list, this would remove
duplications and make the documentation clearer and lighter.
I Cc the doxygen-users list too -sorry for double posting- since someone
there may comment for or against this proposal.
Best regards, Davide
--
============================= Davide Cesari ============================
Servizio IdroMeteorologico ARPA Emilia Romagna
Area Modellistica Numerica e Radarmeteorologia
E-mail: [email protected]
Home page: http://www.webalice.it/o.drofa/davide/
========================================================================
This message has been scanned for malware by Websense. www.websense.com
------------------------------------------------------------------------------
This SF.net email is sponsored by
Make an app they can't live without
Enter the BlackBerry Developer Challenge
http://p.sf.net/sfu/RIM-dev2dev