Project

General

Profile

Actions

Task #4118

closed

NLSR Doxygen

Added by Nicholas Gordon over 7 years ago. Updated about 7 years ago.

Status:
Closed
Priority:
Normal
Target version:
Start date:
06/05/2017
Due date:
% Done:

0%

Estimated time:

Description

Currently, NLSR uses Doxygen only very sparingly, and only on publicly-exposed entities in the source tree. Doxygen is a powerful and structured way to write documentation, not just for APIs, but also for general code structures. Since we can easily toggle what visibility of documentation gets exported, we should write Doxygen documentation for all entities in the source, and generate a developer's version and an API reference version.

I propose that Doxygen comments be written for every non-trivial entity in the source, and those comments should answer the questions: Why is this code entity here? Why does this thing exist? What other entities rely on this one to accomplish their jobs?

Actions #1

Updated by Nicholas Gordon over 7 years ago

  • Status changed from New to Code review
  • Assignee set to Nicholas Gordon
  • Target version set to v0.4.0
Actions #2

Updated by Nicholas Gordon about 7 years ago

  • Status changed from Code review to Closed
Actions

Also available in: Atom PDF