----boundary-LibPST-iamunique-117920226_-_-
Content-type: text/plain
Andrew,
Sounds nice.
What does the user actually have to do to produce the documentation
after the folds have been added?
Is it a single call like 'ModifiedDevBrowser.Document filename'?
-Doug
A Thomas wrote:
>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>
>
>
>
--- BlackBox
--- send subject HELP or UNSUBSCRIBE to blackbox{([at]})nowhere.xy
----boundary-LibPST-iamunique-117920226_-_-
Content-type: application/rtf
Content-transfer-encoding: base64
Content-Disposition: attachment; filename="rtf-body.rtf"
e1xydGYxXGFuc2lcYW5zaWNwZzEyNTJcZnJvbXRleHQgXGRlZmYwe1xmb250dGJsDQp7XGYwXGZz
d2lzcyBBcmlhbDt9DQp7XGYxXGZtb2Rlcm4gQ291cmllciBOZXc7fQ0Ke1xmMlxmbmlsXGZjaGFy
c2V0MiBTeW1ib2w7fQ0Ke1xmM1xmbW9kZXJuXGZjaGFyc2V0MCBDb3VyaWVyIE5ldzt9fQ0Ke1xj
b2xvcnRibFxyZWQwXGdyZWVuMFxibHVlMDtccmVkMFxncmVlbjBcYmx1ZTI1NTt9DQpcdWMxXHBh
cmRccGxhaW5cZGVmdGFiMzYwIFxmMFxmczIwIEFuZHJldyxccGFyDQpTb3VuZHMgbmljZS5ccGFy
DQpXaGF0IGRvZXMgdGhlIHVzZXIgYWN0dWFsbHkgaGF2ZSB0byBkbyB0byBwcm9kdWNlIHRoZSBk
b2N1bWVudGF0aW9uIFxwYXINCmFmdGVyIHRoZSBmb2xkcyBoYXZlIGJlZW4gYWRkZWQ/XHBhcg0K
SXMgaXQgYSBzaW5nbGUgY2FsbCBsaWtlICdNb2RpZmllZERldkJyb3dzZXIuRG9jdW1lbnQgZmls
ZW5hbWUnP1xwYXINCi1Eb3VnXHBhcg0KXHBhcg0KQSBUaG9tYXMgd3JvdGU6XHBhcg0KXHBhcg0K
PkhlaSBCbGFja0JveCB3b3JsZCxccGFyDQo+XHBhcg0KPlx0YWIgSGFzIGFueW9uZSBnb3QgdG9v
bHMgdG8gaGVscCB3cml0ZSBkb2N1bWVudGF0aW9uIGZvciBDUCBtb2R1bGVzPyBJXHBhcg0KPmhh
dmUgYmVlbiBoYXZpbmcgYSBnbyBhdCB0aGlzIGJ1dCBpZiB0aGVyZSBhcmUgdG9vbHMgYWxyZWFk
eSB0aGVyZSBJIHdpbGwgYmVccGFyDQo+bW9yZSB0aGFuIGhhcHB5IHRvIGdpdmUgdXAuLi5ccGFy
DQo+XHBhcg0KPlNvIGZhciBJIGhhdmUgbW9kaWZpZWQgRGV2QnJvd3NlciB0byBwcm9kdWNlIGEg
ZG9jdW1lbnRhdGlvbiBza2VsZXRvbi4gVGhpc1xwYXINCj5jb250YWlucyBTdGRUYXJnZXQgdmll
d3Mgd2l0aCB0YWdzIGJhc2VkIG9uIHRoZSBuYW1lIG9mIHRoZSBleHBvcnRlZCBpdGVtXHBhcg0K
PnRoYXQgbmVlZHMgZG9jdW1lbnRpbmcuIEluIHRoZSBzb3VyY2UgY29kZSBJIGhhdmUgaW5zZXJ0
IGxhYmVsZWQgU3RkRm9sZFxwYXINCj52aWV3cyB3aGljaCBjb250YWluIHRoZSBkb2N1bWVudGF0
aW9uIGFuZCB3aXRoIHRoZSBsYWJlbCBlcXVhbCB0byB0aGUgdGFnIGluXHBhcg0KPnRoZSBTdGRU
YXJnZXQgdmlld3MuIFRoZSBkb2N1bWVudGF0aW9uIGlzIHRoZW4gcHJvZHVjZWQgYnkgZ29pbmcg
dGhyb3VnaCB0aGVccGFyDQo+c291cmNlIGNvZGUgYW5kIHRoZSBkb2N1bWVudGF0aW9uIHRlbXBs
YXRlIGFuZCBtYXRjaGluZyB0aGUgZm9sZCBhbmQgdGFyZ2V0XHBhcg0KPnZpZXdzLiBUaGlzIHNl
ZW1zIHRvIHJ1biBhdCBhIHJlYXNvbmFibGUgc3BlZWQgZm9yIHN1YnN5c3RlbXMgSSBoYXZlIHRy
aWVkLlxwYXINCj5JIGxpa2UgdGhhdCB0aGUgZG9jdW1lbnRhdGlvbiBhbmQgc291cmNlIGNvZGUg
YXJlIGluIHRoZSBzYW1lIGZpbGUuXHBhcg0KPlxwYXINCj5BbnkgaW50ZXJlc3Qgb3IgaWRlYXMg
Zm9yIGltcHJvdmVtZW50IHBsZWFzZSBlbWFpbCBtZSBhdFxwYXINCj5ccGFyDQo+YW50QHJuaS5o
ZWxzaW5raS5maVxwYXINCj5ccGFyDQo+XHBhcg0KPlJlZ2FyZHNccGFyDQo+XHBhcg0KPlx0YWIg
QW5kcmV3XHBhcg0KPlxwYXINCj4tLS0gQmxhY2tCb3hccGFyDQo+LS0tIHNlbmQgc3ViamVjdCBI
RUxQIG9yIFVOU1VCU0NSSUJFIHRvIGJsYWNrYm94QG9iZXJvbi5jaFxwYXINCj5ccGFyDQo+XHBh
cg0KPiAgXHBhcg0KPlxwYXINClxwYXINCi0tLSBCbGFja0JveFxwYXINCi0tLSBzZW5kIHN1Ympl
Y3QgSEVMUCBvciBVTlNVQlNDUklCRSB0byBibGFja2JveEBvYmVyb24uY2hccGFyDQp9fQAAAAAA
----boundary-LibPST-iamunique-117920226_-_---
Received on Mon Oct 17 2005 - 18:45:20 UTC