Makedocs "param" option

Übersicht

BlitzMax, BlitzMax NG

Allgemein

	ProfJake ehemals "DTC" / "Fabian Niemann" Betreff: Makedocs "param" option	Mo, Jun 04, 2012 17:04 Antworten mit Zitat
Hi Crowd, wie Mark Mcvittie hier schon vor über einem Jahr geschrieben hat, gibt es beim Dokumentationsgenerator makedocs der BlitzMax beiliegt die Option einzelne Parameter zu dokumentieren. Theoretisch. Das Problem daran ist, dass es eben nicht funktioniert. Weder im deutschen oder englischen Forum noch im Quelltext selbst lässt sich irgendwas Hilfreiches dazu finden, wie man die Sache zum Laufen kriegt. Hier ein Beispiel, wie es funktionieren sollte: BlitzMax: [AUSKLAPPEN] [EINKLAPPEN] Rem bbdoc: Add a function to be called when the program ends about: OnEnd allows you to specify a function to be called when the program ends. The callback functions are called in the reverse order to that in which they were added. <p class="bbdoc-note">At least 32 callback functions can be registered.</p> param: callback A pointer to the funciton that will be called upon exit End Rem Function OnEnd(callback()) = "bbOnEnd" Hat das schon einmal jemand geschafft? Es wäre nämlich irre praktisch, dafür eine Lösung zu haben die nicht darin besteht, alles in einem Fließtext einfach fett zu kennzeichnen, was ein Parametername ist : ( Fabian

ProfJake

ehemals "DTC" / "Fabian Niemann"

Betreff: Makedocs "param" option

Mo, Jun 04, 2012 17:04
Antworten mit Zitat

Hi Crowd,

wie Mark Mcvittie hier schon vor über einem Jahr geschrieben hat, gibt es beim Dokumentationsgenerator makedocs
der BlitzMax beiliegt die Option einzelne Parameter zu dokumentieren. Theoretisch.

Das Problem daran ist, dass es eben nicht funktioniert. Weder im deutschen oder englischen Forum noch im
Quelltext selbst lässt sich irgendwas Hilfreiches dazu finden, wie man die Sache zum Laufen kriegt.

Hier ein Beispiel, wie es funktionieren sollte:

BlitzMax: [AUSKLAPPEN]

Rem
bbdoc:	Add a function to be called when the program ends
about:	OnEnd allows you to specify a function to be called when the program ends. 
	The callback functions are called in the reverse order to that in which they were added.
		
		<p class="bbdoc-note">At least 32 callback functions can be registered.</p>
param:	callback A pointer to the funciton that will be called upon exit
End Rem
Function OnEnd(callback()) = "bbOnEnd"

Hat das schon einmal jemand geschafft? Es wäre nämlich irre praktisch, dafür eine Lösung zu haben die nicht darin
besteht, alles in einem Fließtext einfach fett zu kennzeichnen, was ein Parametername ist : (

Fabian