#378 Enable tooltip docu of procedures

[Erik Hänel]

Enable tooltip procedure documentation like it is done in MATLAB: the tooltips shall display the documentation comment (##! ... or #*! ... *#), which is either directly above or below the procedure command.

Analysis:

The detection of documentation strings has to be done differently for local and for global procedures:

• local: The editor method wxString NumeReEditor::FindProcedureDefinition() has to search around the matched procedure head for comments, which are possible candidates for documentation strings
• global: The editor method wxString NumeReEditor::FindProcedureDefinition() has to buffer each documentation strings, which it finds until the correct procedure definition. It will discard the documentation string, which are not followed directly by the definition. If it didn't find a documentation string before the definition, it will search the lines after it.

The global rule will be as follows: documentation lines above the definition are preferred, as this is the usual way done by each other documentation system (i.e. DoxyGen). Additionally, documentation strings have to be started at the beginning of the line. Only whitespaces and tabulators are acceptable in front of the documentation lines.

The found documentation lines will be appended after a linebreak character to the detected procedure definition, which allows to display it on the tooltip. This requires some adjustments in the language masks for the procedure tooltips.

Implementation:

• Implementation: The new functionality was implemented as proposed by the analysis.
• Revision: [r397]
• Implementation test: Already available documentations of procedures were tested above and below the procedure head without any deviation.

Documentation:

• ChangesLog: updated
• Comments: The added functions are commented sufficiently.
• Documentation articles: Documentation articles were updated correspondingly.
• Language files: Not needed.

Tests:

This new functionality was tested thoroughly in production tests. All deviations were resolved.