doxygen_todo.m File Reference

-zeile innerhalb der detailbeschreibungen! More...

Go to the source code of this file.

Functions
function	doxygen_todo ()
	-zeile innerhalb der detailbeschreibungen! More...

Detailed Description

-zeile innerhalb der detailbeschreibungen!

Doxygen ToDo

Todo:

readonly-tag: jeder innerhalb eines "Dependent" blocks definierten property einfach einen tag a la

@par "This property is readonly" 

hinzuzufügen. und da es sich in diesem falle eh um Methoden mit "get.<somename>" handelt wäre in einem solchen fall auch der hinweis "Getter is implemented" redundant/überflüssig. done - "See also:" oder "See also" tags: diese sollte man ersetzen durch "@sa". damit ist gewährleistet das die von Matlab selbst erzeugte dokumentation per "doc ." auch noch einigermaßen funktioniert.

Static methods: bei statischen methoden darf der erste parameter nicht weggenommen werden! das ist ja sonst "this", aber z.B. in der Klasse MatUtils gibt es eine static methode aus der der parameter "stencil" entfernt wird; dies gibt bei doxygen später ne fehlermeldung.

events in dokumentation einfügen.

Adding folder to "glob" in mtoc.conf should also add all top-level functions with"" ( )

The file list for each module should contain the full relative path within the project (subfolder/mfilename)

allow detection of nested field parameters , i.e. if a param "model" is given, a reference to model.field1.subfield should be detected and "field1.subfield" be added to the required fields list.

luxus-version: if a field of the param "model" is used like "varname = model.structfield" any statement like "varname.field1" should result in a new entry "model.structfield.field1" in the required fields list (recursively)

if subroutines refer to a fcn param in the outer function's context, the call to any used field should be registered,too and the field added to the "required" list

einfache wiederholung der

Todo:

für abstract-funktionen noch die kommentare mit einfügen (sollten in der dokumentation oben drüber stehen..

Definition in file doxygen_todo.m.

Function Documentation

function doxygen_todo

(

)

-zeile innerhalb der detailbeschreibungen!

Doxygen ToDo

Todo:

readonly-tag: jeder innerhalb eines "Dependent" blocks definierten property einfach einen tag a la

@par "This property is readonly" 

hinzuzufügen. und da es sich in diesem falle eh um Methoden mit "get.<somename>" handelt wäre in einem solchen fall auch der hinweis "Getter is implemented" redundant/überflüssig. done - "See also:" oder "See also" tags: diese sollte man ersetzen durch "@sa". damit ist gewährleistet das die von Matlab selbst erzeugte dokumentation per "doc ." auch noch einigermaßen funktioniert.

Static methods: bei statischen methoden darf der erste parameter nicht weggenommen werden! das ist ja sonst "this", aber z.B. in der Klasse MatUtils gibt es eine static methode aus der der parameter "stencil" entfernt wird; dies gibt bei doxygen später ne fehlermeldung.

events in dokumentation einfügen.

Adding folder to "glob" in mtoc.conf should also add all top-level functions with"" ( )

The file list for each module should contain the full relative path within the project (subfolder/mfilename)

allow detection of nested field parameters , i.e. if a param "model" is given, a reference to model.field1.subfield should be detected and "field1.subfield" be added to the required fields list.

luxus-version: if a field of the param "model" is used like "varname = model.structfield" any statement like "varname.field1" should result in a new entry "model.structfield.field1" in the required fields list (recursively)

if subroutines refer to a fcn param in the outer function's context, the call to any used field should be registered,too and the field added to the "required" list

einfache wiederholung der

Todo:

für abstract-funktionen noch die kommentare mit einfügen (sollten in der dokumentation oben drüber stehen..

Todo:

den copydoc-befehl ggf. bei implementierungen von interface-funktionen oder abstracts einfügen und die doku in einen eigenen

einfügen ("Documentation from original declaration:")

Todo:

nice-to-have: aufruf einer überschriebenen superklassen-methode aus neuer methode fügt kommentare aus superklassenmethode ein? oder zumindest ein hinweis + link auf originalmethode..

Todo:

Default:

-Tag für properties einführen

Todo:

mtoc.conf -> möglichkeit für add(returns) wie add(params)?

Todo:

Bug: kommentare zwischen zwei funktionen in method-blöcken geben nen parse error!

Todo:

Scheinbar kann der parser zwar mehrfachvererbung, aber nur 2 klassen (ein "&" zeichen). Das können aber mehrere sein! dinge wie "properties(Access=private);" mit ";" am ende geben nen parse error; matlab selbst juckts aber nicht. vielleicht einen hinweis einbauen oder am besten gleich ignorieren?

Todo:

thismatlabtypesubstitute -> wird falls vorhanden wohl als typ für alle parameter angenommen! einfacher: den parameter einfach verschwinden lassen.

Todo:

Kommentare zwischen function-blöcken innerhalb von method-blöcken (auskommentierte funktionen) führen zu parse errors

Todo:

bei mehr als einem sub-package in der klassendeklaration bei vererbung (class1 < pck1.pck2.someclass & pck3.pck4.someotherclass) gibt's nen parse error nach "&"

Todo:

einen einführen, der bei properties den angegebenen Typ voranfügt

Todo:

code-umgebung funktioniert nicht in property-descriptions;

<code>some code</code>

geht aber.

Todo:

new bug: models.beam.DynLinTimoshenkoModel.plot has a dot in between and thus the doxygen compiler does not recognize the class member (warning: no uniquely matching class member found for ...)

Definition at line 17 of file doxygen_todo.m.