Project

General

Profile

Actions

Bug #429

closed

Doxygen API documentation for Windows

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

Status:
Closed
Priority:
Normal
Assignee:
-
Category:
Documentation
Target version:
-
Start date:
2012-07-04
Due date:
% Done:

0%

Estimated time:
Module:
ofstd, dcmdata und weitere?
Operating System:
Compiler:

Description

_WIN32 should be entered under PREDEFINED in doxygen/htmldocs.cfg so that the Windows specific parts of the documentation (e.g. OFFile, OFCharacterEncoding) will be transformed into HTML.

Updated by Jörg Riesmeier 7 months ago

  • Tracker changed from Feature to Bug

It also seems that the Defines in "osconfig.h" aren't evaluated. This explains why the new classes OFStandard::OFGroup and OFStandard::OFPasswd are missing in the HTML documentation (generated on caesar)

Actions #1

Updated by Jörg Riesmeier almost 13 years ago

  • Tracker changed from Feature to Bug

Es scheint auch so zu sein, dass die Defines in der "osconfig.h" momentan nicht ausgewertet werden. So fehlt etwas die neue Klasse OFStandard::OFGroup und OFStandard::OFPasswd in der HTML-Dokumentation (auf caesar generiert).

Actions #2

Updated by Uli Schlachter over 12 years ago

IMHO the best solution would be to add a new define DCMTK_RUNNING_UNDER_DOXYGEN and using that to modify all #ifdefs suitably. However, this still sounds ugly. :-(

This awk-magic should produce all #ifs which possible might need an "|| defined(DCMTK_RUNNING_UNDER_DOXYGEN)":

 awk '/^ *#.*ifn?def/ { file=FILENAME ; gsub(/.*\//, "", file) ; gsub(/\.h/, "", file) ; file=toupper(file) ; if (!match($2, file)) { print FILENAME " " $0 } } /^ *#.*defined/ { print FILENAME " " $0}' $(find */include/ -type f)  | sort -u
Actions #3

Updated by Jörg Riesmeier over 12 years ago

Btw, it would also be interesting to mark the platform-specific API in the documentation, i.e. add something like "Windows only" or "Unix only" ...

Actions #4

Updated by Andrew Chiw over 12 years ago

  • Subject changed from Doxygen-API-Dokumentation für Windows-Systeme to Doxygen API documentation for Windows
Actions #5

Updated by Marco Eichelberg over 8 years ago

  • Target version changed from 3.6.2 to 3.6.3
Actions #6

Updated by Marco Eichelberg over 7 years ago

The API documentation should be generated such that all APIs are included in the documentation. For those methods, classes and functions that are only available under certain conditions (compiling on Windows, compiling with OpenSSL etc.), notes should be added in the documentation explaining under which conditions the method/class/function is available.

Actions #7

Updated by Marco Eichelberg over 7 years ago

Test of Redmine mail subsystem, please ignore.

Actions #8

Updated by Jan Schlamelcher over 7 years ago

  • Target version changed from 3.6.3 to 3.6.6
Actions #9

Updated by Michael Onken about 7 years ago

  • Status changed from New to Closed

Closed by commit 9bf0e839e1c2128fdd3d4809705c196388af28cb.

Actions #10

Updated by Michael Onken over 5 years ago

  • Target version deleted (3.6.6)
Actions

Also available in: Atom PDF