Bug 223 – Source: Not all class descriptions doxygenated.

••• Introduction •••
••• Keywords •••

Audacity 3.0.3 development began 19th April 2021

Audacity Bugzilla

Bug 223 - Source: Not all class descriptions doxygenated.


Summary:	Source: Not all class descriptions doxygenated.

Status:	CLOSED NOT-A-BUG

Product:	Audacity
Classification:	Unclassified
Component:	Application Core
Version:	1.3.14 alpha
Hardware:	Per OS All

Importance:	P4 Review
Assigned To:	Default Assignee for New Bugs

URL:
Keywords:

Depends on:
Blocks:
	Show dependency tree / graph

Reported:	2010-09-07 05:57 UTC by James Crook
Modified:	2018-08-20 11:45 UTC (History)
CC List:	2 users (show)

See Also:
Steps To Reproduce:	Run doxygen using the audacity.dox config file in the /Audacity directory. Look at the classes page. Some classes are missing descriptions.
Release Note:
First Git SHA:
Group:	---
Workaround:
Closed:	2018-08-20 00:00:00

Flags:	james.k.crook: Maintainability+

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.

Description James Crook 2010-09-07 05:57:50 UTC

We aim to have all classes in Audacity itself have a brief doxygen comment describing what they do.

This is a non-critical issue, but addressing it may help us gather new contributors.  This bug is likely to get closed and reopened many times until developers get into the habit of adding new doxygen comments with any new classes they add.

Comment 1 James Crook 2017-08-30 12:20:55 UTC

Changed from RepeatableAll to Review, as this will be a perennial.  I.e. we'll need to review it repeatedly.  Perhaps we need a better way to handle Review bugs than Bugzilla?

Comment 2 James Crook 2018-04-12 07:41:37 UTC

Closing as NOT-A-BUG.

This does not affect end users at all.
  
I think we don't want to keep most REVIEW issues in Bugzilla, as they just get forgotten here and clog up real bug tracking.  They need to be in wiki as active projects and similar.

Besides were this a bug, it would be a perennial/zombie un-permanently-killable 'bug'.  It can't be closed.