Translations:Doxygen/45/de
Einige der häufigsten Schlüsselwörter, die in der FreeCAD Dokumentation verwendet werden, sind hier aufgeführt.
\defgroup <name> (Gruppentitel)
, siehe \defgroup, undGruppierung.\ingroup (<groupname> [<groupname> <groupname> <groupname>])
, siehe\ingroup, undGruppierung.
\addtogroup <name> <name> [(title)]
, siehe \addtogroup, undGruppierung.
\author { list of authors }
, siehe \author; gibt den Autor dieses Stückes Code an.\brief {kurze Beschreibung }
, siehe \brief; beschreibt kurz die Funktion.\file [<name>]
, siehe \file; dokumentiert eine Quell- oder Header-Datei.\page <name> (title)
, siehe \page; stellt die Informationen auf eine separate Seite, nicht direkt in Bezug stehend mit einer bestimmten Klasse, Datei oder einem Mitglied.\package <name>
, siehe\package; zeigt die Dokumentation für ein Java Paket an (wird aber auch mit Python verwendet).\fn (Funktionsdeklaration)
, siehe\fn; dokumentiert eine Funktion.\var (Variablendeklaration)
, siehe\var; dokumentiert eine Variable; sie entspricht\fn
,\property
}, und\typedef
}.\section <section-name> (section title)
, siehe\section; startet einen Abschnitt.
\subsection <subsection-name> (subection title)
, siehe\subsection; startet einen Unterabschnitt.
\namespace <name>
, siehe\namespace; zeigt Informationen für einen Namensraum an.\cond [(section-label)]
, und\endcond
, siehe\cond; definiert einen Block, der bedingt dokumentiert oder weggelassen werden soll.\a <word>
, siehe\a; zeigt das Argument kursiv zur Hervorhebung an.\param [(dir)] <parameter-name> { parameter description }
, siehe\param; gibt den Parameter einer Funktion an.
\return { Beschreibung des Rückgabewertes }
, siehe\return; gibt den Rückgabewert an.