- Documenting CP modules

From: A Thomas <"A>
Date: Thu, 13 Oct 2005 10:34:27 +0300

----boundary-LibPST-iamunique-1464321379_-_-
Content-type: text/plain

Hei BlackBox world,

        Has anyone got tools to help write documentation for CP modules? I
have been having a go at this but if there are tools already there I will be
more than happy to give up...

So far I have modified DevBrowser to produce a documentation skeleton. This
contains StdTarget views with tags based on the name of the exported item
that needs documenting. In the source code I have insert labeled StdFold
views which contain the documentation and with the label equal to the tag in
the StdTarget views. The documentation is then produced by going through the
source code and the documentation template and matching the fold and target
views. This seems to run at a reasonable speed for subsystems I have tried.
I like that the documentation and source code are in the same file.

Any interest or ideas for improvement please email me at

ant{([at]})nowhere.xy


Regards

        Andrew

--- BlackBox
--- send subject HELP or UNSUBSCRIBE to blackbox{([at]})nowhere.xy



----boundary-LibPST-iamunique-1464321379_-_-
Content-type: application/rtf
Content-transfer-encoding: base64
Content-Disposition: attachment; filename="rtf-body.rtf"

e1xydGYxXGFuc2lcYW5zaWNwZzEyNTJcZnJvbXRleHQgXGRlZmYwe1xmb250dGJsDQp7XGYwXGZz
d2lzcyBBcmlhbDt9DQp7XGYxXGZtb2Rlcm4gQ291cmllciBOZXc7fQ0Ke1xmMlxmbmlsXGZjaGFy
c2V0MiBTeW1ib2w7fQ0Ke1xmM1xmbW9kZXJuXGZjaGFyc2V0MCBDb3VyaWVyIE5ldzt9fQ0Ke1xj
b2xvcnRibFxyZWQwXGdyZWVuMFxibHVlMDtccmVkMFxncmVlbjBcYmx1ZTI1NTt9DQpcdWMxXHBh
cmRccGxhaW5cZGVmdGFiMzYwIFxmMFxmczIwIEhlaSBCbGFja0JveCB3b3JsZCxccGFyDQpccGFy
DQpcdGFiIEhhcyBhbnlvbmUgZ290IHRvb2xzIHRvIGhlbHAgd3JpdGUgZG9jdW1lbnRhdGlvbiBm
b3IgQ1AgbW9kdWxlcz8gSVxwYXINCmhhdmUgYmVlbiBoYXZpbmcgYSBnbyBhdCB0aGlzIGJ1dCBp
ZiB0aGVyZSBhcmUgdG9vbHMgYWxyZWFkeSB0aGVyZSBJIHdpbGwgYmVccGFyDQptb3JlIHRoYW4g
aGFwcHkgdG8gZ2l2ZSB1cC4uLlxwYXINClxwYXINClNvIGZhciBJIGhhdmUgbW9kaWZpZWQgRGV2
QnJvd3NlciB0byBwcm9kdWNlIGEgZG9jdW1lbnRhdGlvbiBza2VsZXRvbi4gVGhpc1xwYXINCmNv
bnRhaW5zIFN0ZFRhcmdldCB2aWV3cyB3aXRoIHRhZ3MgYmFzZWQgb24gdGhlIG5hbWUgb2YgdGhl
IGV4cG9ydGVkIGl0ZW1ccGFyDQp0aGF0IG5lZWRzIGRvY3VtZW50aW5nLiBJbiB0aGUgc291cmNl
IGNvZGUgSSBoYXZlIGluc2VydCBsYWJlbGVkIFN0ZEZvbGRccGFyDQp2aWV3cyB3aGljaCBjb250
YWluIHRoZSBkb2N1bWVudGF0aW9uIGFuZCB3aXRoIHRoZSBsYWJlbCBlcXVhbCB0byB0aGUgdGFn
IGluXHBhcg0KdGhlIFN0ZFRhcmdldCB2aWV3cy4gVGhlIGRvY3VtZW50YXRpb24gaXMgdGhlbiBw
cm9kdWNlZCBieSBnb2luZyB0aHJvdWdoIHRoZVxwYXINCnNvdXJjZSBjb2RlIGFuZCB0aGUgZG9j
dW1lbnRhdGlvbiB0ZW1wbGF0ZSBhbmQgbWF0Y2hpbmcgdGhlIGZvbGQgYW5kIHRhcmdldFxwYXIN
CnZpZXdzLiBUaGlzIHNlZW1zIHRvIHJ1biBhdCBhIHJlYXNvbmFibGUgc3BlZWQgZm9yIHN1YnN5
c3RlbXMgSSBoYXZlIHRyaWVkLlxwYXINCkkgbGlrZSB0aGF0IHRoZSBkb2N1bWVudGF0aW9uIGFu
ZCBzb3VyY2UgY29kZSBhcmUgaW4gdGhlIHNhbWUgZmlsZS5ccGFyDQpccGFyDQpBbnkgaW50ZXJl
c3Qgb3IgaWRlYXMgZm9yIGltcHJvdmVtZW50IHBsZWFzZSBlbWFpbCBtZSBhdFxwYXINClxwYXIN
CmFudEBybmkuaGVsc2lua2kuZmlccGFyDQpccGFyDQpccGFyDQpSZWdhcmRzXHBhcg0KXHBhcg0K
XHRhYiBBbmRyZXdccGFyDQpccGFyDQotLS0gQmxhY2tCb3hccGFyDQotLS0gc2VuZCBzdWJqZWN0
IEhFTFAgb3IgVU5TVUJTQ1JJQkUgdG8gYmxhY2tib3hAb2Jlcm9uLmNofX0AWEprY3l4Y2NHRg==


----boundary-LibPST-iamunique-1464321379_-_---
Received on Thu Oct 13 2005 - 09:34:27 UTC