Doxygen Bug
-
Hallo,
ich will meinen Code mit Doxygen dokumentieren, nur leider gibt es ein Problem.
Wenn ich ein einer Klasse mehrere Member in einer Zeile definiere und diese dann kommentieren will, erscheint in der Doku immer nur das letzte Member:
float a,b,c; ///< Drei MemberIn der Doxygen Doku steht dann nur da:
float c
Drei MemberIst das ein Bug? Oder kann man es irgendwie einstellen, dass er alle Member in der Doku auflisten soll?!
-
Benutzt hier echt niemand Doxygen?
-
Wozu soll das gut sein, dieses Doxygen?
-
Eine Doku zu erstellen...
Meines Wissens kannst du die Variablen aber nur einzeln dokumentieren und ich verstehe auch nicht so ganz, wieso du das anders machen wolltest.
-
JustAnotherNoob schrieb:
Eine Doku zu erstellen...
Meines Wissens kannst du die Variablen aber nur einzeln dokumentieren und ich verstehe auch nicht so ganz, wieso du das anders machen wolltest.
Naja, sowas macht man doch ständig, mehrere Variablen in eine Zeile.
Sowas wiefloat a,b,c,d;ist einfach bequemer/kompakter als
float a; float b; float c; float d;Dass an sowas Doxygen bereits scheitert finde ich echt schwach..
-
Naja, sowas macht man doch ständig, mehrere Variablen in eine Zeile.
Echt? Ich mach sowas eigentlich nie, wüsste jetzt auch spontan keine Situation wo das sinnvoll sein könnte.
-
wieso sollte es auch sinnvoll sein, dann davon auszugehen, dass alle Variablen in einer Zeile für das gleiche gebraucht werden und somit gleich Dokumentiert gehören?
-
Also bei mir ist der Output:
· int a · int b · int c Drei Member.Muss also pebkac sein.
-
Wenn du mehrere Sachen dokumentieren willst dann musst du das ja auch folgend machen:
int a, ///< Member a
b, ///< Member b
c; ///< Member cbzw gruppieren(soweit ich mich erinnere):
/**
Drei Member
{/
int a, b ,b;
/**}*/Und das mal abgesehen davon das ich den Text "Drei Member" nicht dokumentationswürdig finden würde...
-
Das mit den "3 Member" Kommentar war natürlich ein echter Kommentar und nicht nur ein simples Beispiel für diese Frage hier.
@Tim: Per default geht es schon mal nicht, also kannst du dir deine arroganten Sprüche sparen.
-
doxy11 schrieb:
@Tim: Per default geht es schon mal nicht, also kannst du dir deine arroganten Sprüche sparen.
Der arrogante Spruch war eine Reaktion auf den arroganten, falschen Spruch:
doxy11 schrieb:
Dass an sowas Doxygen bereits scheitert finde ich echt schwach..
Warum es bei mir geht, bei dir aber nicht kann ich nicht sagen, aber jetzt weisst du ja, dass es prinzipiell geht. Und grouping wurde ja auch angesprochen (auch wenn mir das in diesem Fall unnötig kompliziert erscheint). Ich kann heute abend evtl. das doxyfile mal posten, wenn gewünscht.
-
Hallo!
Also bei mir werden zwar alle drei Varablen aufgelisted, jedoch wird das Kommentar nur zu der ersten hinzugefügt. Ich verstehe allerding auch nicht, warum man zu drei Variablen ein Kommentar benutzen will, der sagt doch dann nicht viel aus?!ich hätt da auch noch mal ne Frage:
kennt sich jemand mit dem Formatieren von Bildern in doxygen aus?
Ich hab ein paar JEPGs eingefügt und möchte, dass diese Linksbündig dargestellt werden. Jedoch werden alle meine Anweisungen wie <div align="left">, align="left", class="bild" ignoriert. ich habe eine eigene css datei als Template vorgegeben, in der ich die class bild definiert habe. Formeln, die als PNGs eingebunden werden habe ich geschafft nach links zu versetzen, doch auch wenn ich die dafür vorgesehene class der img - Anweisung mitgebe, wird das auch ignoriert und die Bilder werden immer zentriert dargestellt.
Hat jemand ne Idee, wie ich die Bilder nach links kriege?Vielen Dank, Tina
-
@Tim: Ja, das wäre nett. ich habe nichts in der Doku gefunden und wegen so einer normalen Sache will ich nicht das (hässliche) Grouping verwenden.
-
Was ist denn nun Tim?
-
Oh, sorry. Hab ich total vergessen.
# Doxyfile 1.5.5 #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- DOXYFILE_ENCODING = UTF-8 PROJECT_NAME = DoxyTest PROJECT_NUMBER = 1.00alpha OUTPUT_DIRECTORY = /home/tim/src/c/doxytest/doxygen/ CREATE_SUBDIRS = NO OUTPUT_LANGUAGE = English BRIEF_MEMBER_DESC = YES REPEAT_BRIEF = YES ABBREVIATE_BRIEF = "The $name class" \ "The $name widget" \ "The $name file" \ is \ provides \ specifies \ contains \ represents \ a \ an \ the ALWAYS_DETAILED_SEC = NO INLINE_INHERITED_MEMB = NO FULL_PATH_NAMES = YES STRIP_FROM_PATH = /home/tim/src/c/doxytest/doxygen/ STRIP_FROM_INC_PATH = SHORT_NAMES = NO JAVADOC_AUTOBRIEF = NO QT_AUTOBRIEF = NO MULTILINE_CPP_IS_BRIEF = NO DETAILS_AT_TOP = NO INHERIT_DOCS = YES SEPARATE_MEMBER_PAGES = NO TAB_SIZE = 8 ALIASES = OPTIMIZE_OUTPUT_FOR_C = YES OPTIMIZE_OUTPUT_JAVA = NO OPTIMIZE_FOR_FORTRAN = NO OPTIMIZE_OUTPUT_VHDL = NO BUILTIN_STL_SUPPORT = NO CPP_CLI_SUPPORT = NO SIP_SUPPORT = NO DISTRIBUTE_GROUP_DOC = NO SUBGROUPING = YES TYPEDEF_HIDES_STRUCT = NO #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- EXTRACT_ALL = YES EXTRACT_PRIVATE = YES EXTRACT_STATIC = YES EXTRACT_LOCAL_CLASSES = YES EXTRACT_LOCAL_METHODS = NO EXTRACT_ANON_NSPACES = NO HIDE_UNDOC_MEMBERS = NO HIDE_UNDOC_CLASSES = NO HIDE_FRIEND_COMPOUNDS = NO HIDE_IN_BODY_DOCS = NO INTERNAL_DOCS = NO CASE_SENSE_NAMES = YES HIDE_SCOPE_NAMES = NO SHOW_INCLUDE_FILES = YES INLINE_INFO = YES SORT_MEMBER_DOCS = YES SORT_BRIEF_DOCS = NO SORT_GROUP_NAMES = NO SORT_BY_SCOPE_NAME = NO GENERATE_TODOLIST = YES GENERATE_TESTLIST = YES GENERATE_BUGLIST = YES GENERATE_DEPRECATEDLIST= YES ENABLED_SECTIONS = MAX_INITIALIZER_LINES = 30 SHOW_USED_FILES = YES SHOW_DIRECTORIES = NO FILE_VERSION_FILTER = #--------------------------------------------------------------------------- # configuration options related to warning and progress messages #--------------------------------------------------------------------------- QUIET = NO WARNINGS = YES WARN_IF_UNDOCUMENTED = YES WARN_IF_DOC_ERROR = YES WARN_NO_PARAMDOC = NO WARN_FORMAT = "$file:$line: $text" WARN_LOGFILE = #--------------------------------------------------------------------------- # configuration options related to the input files #--------------------------------------------------------------------------- INPUT = /home/tim/src/c/doxytest/src/ INPUT_ENCODING = UTF-8 FILE_PATTERNS = *.c \ *.cc \ *.cxx \ *.cpp \ *.c++ \ *.d \ *.java \ *.ii \ *.ixx \ *.ipp \ *.i++ \ *.inl \ *.h \ *.hh \ *.hxx \ *.hpp \ *.h++ \ *.idl \ *.odl \ *.cs \ *.php \ *.php3 \ *.inc \ *.m \ *.mm \ *.dox \ *.py \ *.C \ *.CC \ *.C++ \ *.II \ *.I++ \ *.H \ *.HH \ *.H++ \ *.CS \ *.PHP \ *.PHP3 \ *.M \ *.MM \ *.PY RECURSIVE = YES EXCLUDE = EXCLUDE_SYMLINKS = NO EXCLUDE_PATTERNS = EXCLUDE_SYMBOLS = EXAMPLE_PATH = EXAMPLE_PATTERNS = * EXAMPLE_RECURSIVE = NO IMAGE_PATH = INPUT_FILTER = FILTER_PATTERNS = FILTER_SOURCE_FILES = NO #--------------------------------------------------------------------------- # configuration options related to source browsing #--------------------------------------------------------------------------- SOURCE_BROWSER = NO INLINE_SOURCES = NO STRIP_CODE_COMMENTS = YES REFERENCED_BY_RELATION = NO REFERENCES_RELATION = NO REFERENCES_LINK_SOURCE = YES USE_HTAGS = NO VERBATIM_HEADERS = NO #--------------------------------------------------------------------------- # configuration options related to the alphabetical class index #--------------------------------------------------------------------------- ALPHABETICAL_INDEX = NO COLS_IN_ALPHA_INDEX = 5 IGNORE_PREFIX = #--------------------------------------------------------------------------- # configuration options related to the HTML output #--------------------------------------------------------------------------- GENERATE_HTML = YES HTML_OUTPUT = html HTML_FILE_EXTENSION = .html HTML_HEADER = HTML_FOOTER = HTML_STYLESHEET = HTML_ALIGN_MEMBERS = YES GENERATE_HTMLHELP = NO GENERATE_DOCSET = NO DOCSET_FEEDNAME = "Doxygen generated docs" DOCSET_BUNDLE_ID = org.doxygen.Project HTML_DYNAMIC_SECTIONS = NO CHM_FILE = HHC_LOCATION = GENERATE_CHI = NO BINARY_TOC = NO TOC_EXPAND = NO DISABLE_INDEX = NO ENUM_VALUES_PER_LINE = 4 GENERATE_TREEVIEW = YES TREEVIEW_WIDTH = 250 #--------------------------------------------------------------------------- # configuration options related to the LaTeX output #--------------------------------------------------------------------------- GENERATE_LATEX = YES LATEX_OUTPUT = latex LATEX_CMD_NAME = latex MAKEINDEX_CMD_NAME = makeindex COMPACT_LATEX = NO PAPER_TYPE = a4 EXTRA_PACKAGES = LATEX_HEADER = PDF_HYPERLINKS = YES USE_PDFLATEX = YES LATEX_BATCHMODE = NO LATEX_HIDE_INDICES = NO #--------------------------------------------------------------------------- # configuration options related to the RTF output #--------------------------------------------------------------------------- GENERATE_RTF = NO RTF_OUTPUT = rtf COMPACT_RTF = NO RTF_HYPERLINKS = NO RTF_STYLESHEET_FILE = RTF_EXTENSIONS_FILE = #--------------------------------------------------------------------------- # configuration options related to the man page output #--------------------------------------------------------------------------- GENERATE_MAN = NO MAN_OUTPUT = man MAN_EXTENSION = .3 MAN_LINKS = NO #--------------------------------------------------------------------------- # configuration options related to the XML output #--------------------------------------------------------------------------- GENERATE_XML = NO XML_OUTPUT = xml XML_SCHEMA = XML_DTD = XML_PROGRAMLISTING = YES #--------------------------------------------------------------------------- # configuration options for the AutoGen Definitions output #--------------------------------------------------------------------------- GENERATE_AUTOGEN_DEF = NO #--------------------------------------------------------------------------- # configuration options related to the Perl module output #--------------------------------------------------------------------------- GENERATE_PERLMOD = NO PERLMOD_LATEX = NO PERLMOD_PRETTY = YES PERLMOD_MAKEVAR_PREFIX = #--------------------------------------------------------------------------- # Configuration options related to the preprocessor #--------------------------------------------------------------------------- ENABLE_PREPROCESSING = YES MACRO_EXPANSION = NO EXPAND_ONLY_PREDEF = NO SEARCH_INCLUDES = YES INCLUDE_PATH = INCLUDE_FILE_PATTERNS = PREDEFINED = EXPAND_AS_DEFINED = SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- # Configuration::additions related to external references #--------------------------------------------------------------------------- TAGFILES = GENERATE_TAGFILE = ALLEXTERNALS = NO EXTERNAL_GROUPS = YES PERL_PATH = /usr/bin/perl #--------------------------------------------------------------------------- # Configuration options related to the dot tool #--------------------------------------------------------------------------- CLASS_DIAGRAMS = NO MSCGEN_PATH = HIDE_UNDOC_RELATIONS = YES HAVE_DOT = NO CLASS_GRAPH = YES COLLABORATION_GRAPH = YES GROUP_GRAPHS = YES UML_LOOK = NO TEMPLATE_RELATIONS = NO INCLUDE_GRAPH = YES INCLUDED_BY_GRAPH = YES CALL_GRAPH = NO CALLER_GRAPH = NO GRAPHICAL_HIERARCHY = YES DIRECTORY_GRAPH = YES DOT_IMAGE_FORMAT = png DOT_PATH = DOTFILE_DIRS = DOT_GRAPH_MAX_NODES = 50 MAX_DOT_GRAPH_DEPTH = 1000 DOT_TRANSPARENT = NO DOT_MULTI_TARGETS = NO GENERATE_LEGEND = YES DOT_CLEANUP = YES #--------------------------------------------------------------------------- # Configuration::additions related to the search engine #--------------------------------------------------------------------------- SEARCHENGINE = NOKann aber sein, dass das File sonst nicht viel tolles macht, hab das vor Ewigkeiten mal aufgesetzt...