Learn how easy it is to sync an existing GitHub or Google Code repo to a SourceForge project! See Demo

Close

#232 Report Manual Does not appear to explain report headers.

closed-fixed
elsapo
Docs (7)
5
2005-11-25
2005-11-21
Larry
No

At the top of every report are or should be these
headers. Is this is all of them?

I did not see any of them mentioned in the report manual.

@progname
@version
@author
@category
@output
@description

Perhaps a sample report template could be included in
the documentation. Something like the following:

The Following is a Sample Report Template:

/*
* @progname reportname
* @version Version Number.
* @author report author & possible email address
* @category ????
* @output Format of Report Output
* @description The following paragraph is used to
populate index.html.

This report ....
*/

proc main()
{

}

The Following Is A Detailed Explanation:

/*
* @progname The name of the report without the
extension. This shows in the pick report option.
* @version Version Number of the report. This
is stored here and not in the report name.
* @author Name of the author of this report
and email address if he/she desires.
* @category ????
* @output Modifies Database | text | HTML |
GEDCOM | RTF | XML | PostScript | etc.
* @description The first paragraph after this is
used to generate the description in the index.html.

This report ....
*/

proc main() /*Every report has to have a main
procedure, there can be only one.*/
{

}

Discussion

  • Larry
    Larry
    2005-11-21

    • summary: Report Manual Does not appear to explain reprot headers. --> Report Manual Does not appear to explain report headers.
     
  • elsapo
    elsapo
    2005-11-25

    Logged In: YES
    user_id=1195173

    Proposals look good to me

     
  • elsapo
    elsapo
    2005-11-25

    Logged In: YES
    user_id=1195173

    Fixed in cvs.

    **

    Add report template, and explanation of report header
    comments, to report manual. sf#1362488.

    **

    Checking in ChangeLog;
    /cvsroot/lifelines/lifelines/ChangeLog,v <-- ChangeLog
    new revision: 1.1757; previous revision: 1.1756
    done
    Checking in docs/ll-reportmanual.xml;
    /cvsroot/lifelines/lifelines/docs/ll-reportmanual.xml,v <--
    ll-reportmanual.xml
    new revision: 1.65; previous revision: 1.64
    done

    Success, CVS operation completed

     
  • elsapo
    elsapo
    2005-11-25

    • assigned_to: nobody --> elsapo
    • status: open --> closed-fixed