Menu

#193 Standardised file description comment

unspecified
pending
nobody
1
2026-03-27
2022-01-29
No

I propose updating all of our source code to use a standardised file description comment, using the Doxygen \file tag and description, followed by copyright notices and a reference to our license details.

I made this change in Owlet [r2173] a long time ago. As for the main OWLNext source code, all my files contributed to the project, as well as some of the major refactoring I have done in existing files, use this file description comment as well.

I propose that all new source code files contributed to the project use this standardised file description comment, and that this is prescribed in our Coding Standards.

//
/// \file
/// <description>
//
// Part of OWLNext - the next generation Object Windows Library
// <copyright notices>
//
// For more information, including license details, see
// https://sourceforge.net/projects/owlnext
//

Note: If you take on this ticket and make the effort to update existing files, be careful not to remove copyright notices or any terms included by the copyright holders (unless they have given permission, of course).

Related

Bugs: #527
Commit: [r2173]
Wiki: Coding_Standards

Discussion

  • Vidar Hasfjord

    Vidar Hasfjord - 2022-02-08

    A section with this recommendation has now been added in our documentation guidelines.

     

    Related

    Wiki: Doxygen_documentation_guidelines

  • Vidar Hasfjord

    Vidar Hasfjord - 2023-09-10
    • status: open --> pending
    • assigned_to: Vidar Hasfjord
    • Group: unspecified --> Owlet
     
  • Vidar Hasfjord

    Vidar Hasfjord - 2025-04-17
    • labels: Documentation --> Documentation, Cleanup
     
  • Vidar Hasfjord

    Vidar Hasfjord - 2026-03-27
    • Group: Owlet --> unspecified
     
  • Vidar Hasfjord

    Vidar Hasfjord - 2026-03-27
    • Labels: Documentation, Cleanup --> Documentation, Cleanup, Owlet
     
  • Vidar Hasfjord

    Vidar Hasfjord - 2026-03-27
    • assigned_to: Vidar Hasfjord --> nobody
     

Anonymous
Anonymous

Add attachments
Cancel





MongoDB Logo MongoDB