Project

General

Profile

Actions
Copy link

Bug #532

closed

Doxygen: missing documentation for enums (e.g. DcmCloseAssociationType)

Added by Jörg Riesmeier about 12 years ago. Updated over 5 years ago.

Status:
Closed
Priority:
Normal
Assignee:
Jörg Riesmeier
Category:
Documentation
Target version:
-
Start date:
2013-07-12
Due date:
% Done:

100%

Estimated time:
Module:
dcmnet and others
Operating System:
Compiler:

Description

Although the enums DcmCloseAssociationType and DcmStorageMode are documented in "dcmtk/dcmnet/scu.h", they are not hyperlinked in the HTML documentation generated by Doxygen. Maybe, this also applies to other enumeration types!?

Actions
Copy link
 #1

Updated by Jörg Riesmeier over 11 years ago

  • % Done changed from 0 to 10
  • Module changed from dcmnet and other? to dcmnet and others

The trick is that Doxygen requires the following lines in order to parse global type definitions, enums, functions, etc. for generating the documentation:

// include this file in doxygen documentation  *

/** @file scu.h
 *  @brief general Service Class User (SCU) class
 */

I started with some obvious files in ofstd, dcmdata, dcmimgle, dcmnet.

Actions
Copy link
 #2

Updated by Marco Eichelberg over 8 years ago

  • Target version changed from 3.6.2 to 3.6.3
Actions
Copy link
 #3

Updated by Marco Eichelberg almost 8 years ago

  • Target version changed from 3.6.3 to 3.6.6
Actions
Copy link
 #4

Updated by Jörg Riesmeier about 7 years ago

  • Status changed from New to Closed
  • Assignee set to Jörg Riesmeier
  • % Done changed from 10 to 100

See commit 814cfb0.

Actions
Copy link
 #5

Updated by Michael Onken over 5 years ago

  • Target version deleted (3.6.6)
Actions
Copy link

Also available in: Atom PDF