Komplexe Funktionen sowie Variablen, Aufrufe, die nicht selbsterklärend sind, werden im Quellcode auf folgende Art und Weise dokumentiert:
PHP DOC:
/**
* Get all image nodes.
*
* @param \DOMNode $node The \DOMDocument instance
* @param boolean $strict If the document has to be valid
*
* @return \DOMNode
*/
public function getImageNodes(\DOMNode $node, $strict = true)
{
// ...
}
JS DOC:
/**
* Returns the pre-computed circumference of the Circle.
*
* @return {number} The circumference of the circle.
*/
Circle.prototype.getCircumference = function () {
return this.circumference;
};
Beispiele von Standardfunktionen:
myJR.onLoad // Wird immer bei Onload eines Dialoges verwendet bzw. aufgerufen.
myR.dialogElementNameOnChange // bezieht sich auf das DialogElement mit dem Namen "dialogElementName" und wird beim "onChange" ausgeführt