#3 Add Doxygen to track.cpp

closed-fixed
None
5
2008-08-20
2008-06-18
Anonymous
No

This patches adds preliminary Doxygen documentation to the src/core/track.cpp file.

The documentation is based on my incomplete understanding of what the various components do. In several places I have left specific /todo notes where I know that I just haven't understood something, but the whole documentation needs review by the developers to make sure that it is accurate, relevant and not misleading. Ideally this patch would be added to the source and then additional documentation added in separate commits.

I'm working on the principle that partial documentation is better than no documentation, but inaccurate documentation is worse than none.

Discussion

  • Nobody/Anonymous

    Track.cpp patch from svn diff

     
    Attachments
  • Paul Wayper

    Paul Wayper - 2008-06-18

    Logged In: YES
    user_id=69565
    Originator: NO

    Sorry, this was from me (Paul Wayper)

     
  • Tobias Doerffel

    Tobias Doerffel - 2008-08-20

    Logged In: YES
    user_id=976770
    Originator: NO

    Already included in SVN, so closing this.

     
  • Tobias Doerffel

    Tobias Doerffel - 2008-08-20
    • assigned_to: nobody --> tobydox
    • status: open --> closed-fixed
     

Get latest updates about Open Source Projects, Conferences and News.

Sign up for the SourceForge newsletter:





No, thanks