Re: [BLACKBOX] Exported comments

From: [at]} <Josef>
Date: Wed, 13 Oct 2010 01:43:33 +0200

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

interesting indeed. There must be some other tool that is used by omc for creating
API docu from a source file. The definition is created from the Symbolfile,
which does not contain comments.

Also interesting in 'Documentation Conventions':

In BlackBox, all procedures whose names start with "Init" may be called only once per object, i.e., they are "snappy".
I did not know that. Is it true? Or dows it apply only to the presented example.
In this case the text is misleading.


- Josef



----- Original Message -----
From: Douglas G. Danforth
To: BLACKBOX{([at]})nowhere.xy
Sent: Wednesday, October 13, 2010 12:03 AM
Subject: [BLACKBOX] Exported comments


In Docu/BB-Rules we find

"5 Comments

Comments which are part of an interface description (rather than a mere implementation description)
have additional asterisks, a kind of "export mark" for comments, e.g. (** guard for xyz command **)"

I interpret that to mean that "(** export me! **)" would put the text "export me!" into the definition
file of a module (i.e. typing Ctrl-D would show that text in the displayed file), however that
does not occur.

Am I misreading that or is there something else one needs to do in order to export a comment?

-Doug Danforth



---- To unsubscribe, send a message with body "SIGNOFF BLACKBOX" to LISTSERV{([at]})nowhere.xy

----
To unsubscribe, send a message with body "SIGNOFF BLACKBOX" to LISTSERV{([at]})nowhere.xy----boundary-LibPST-iamunique-220933718_-_-
Content-type: application/rtf
Content-transfer-encoding: base64
Content-Disposition: attachment; filename="rtf-body.rtf"
e1xydGYxXGFuc2lcYW5zaWNwZzEyNTJcZnJvbXRleHQgXGRlZmYwe1xmb250dGJsDQp7XGYwXGZz
d2lzcyBBcmlhbDt9DQp7XGYxXGZtb2Rlcm4gQ291cmllciBOZXc7fQ0Ke1xmMlxmbmlsXGZjaGFy
c2V0MiBTeW1ib2w7fQ0Ke1xmM1xmbW9kZXJuXGZjaGFyc2V0MCBDb3VyaWVyIE5ldzt9fQ0Ke1xj
b2xvcnRibFxyZWQwXGdyZWVuMFxibHVlMDtccmVkMFxncmVlbjBcYmx1ZTI1NTt9DQpcdWMxXHBh
cmRccGxhaW5cZGVmdGFiMzYwIFxmMFxmczIwIGludGVyZXN0aW5nIGluZGVlZC4gVGhlcmUgbXVz
dCBiZSBzb21lIG90aGVyIHRvb2wgdGhhdCBpcyB1c2VkIGJ5IG9tYyBmb3IgY3JlYXRpbmdccGFy
DQpBUEkgZG9jdSBmcm9tIGEgc291cmNlIGZpbGUuIFRoZSBkZWZpbml0aW9uIGlzIGNyZWF0ZWQg
ZnJvbSB0aGUgU3ltYm9sZmlsZSxccGFyDQp3aGljaCBkb2VzIG5vdCBjb250YWluIGNvbW1lbnRz
LlxwYXINClxwYXINCkFsc28gaW50ZXJlc3RpbmcgaW4gJ0RvY3VtZW50YXRpb24gQ29udmVudGlv
bnMnOlxwYXINClxwYXINCkluIEJsYWNrQm94LCBhbGwgcHJvY2VkdXJlcyB3aG9zZSBuYW1lcyBz
dGFydCB3aXRoICJJbml0IiBtYXkgYmUgY2FsbGVkIG9ubHkgb25jZSBwZXIgb2JqZWN0LCBpLmUu
LCB0aGV5IGFyZSAic25hcHB5Ii5ccGFyDQpJIGRpZCBub3Qga25vdyB0aGF0LiBJcyBpdCB0cnVl
PyBPciBkb3dzIGl0IGFwcGx5IG9ubHkgdG8gdGhlIHByZXNlbnRlZCBleGFtcGxlLlxwYXINCklu
IHRoaXMgY2FzZSB0aGUgdGV4dCBpcyBtaXNsZWFkaW5nLlxwYXINClxwYXINClxwYXINCi0gSm9z
ZWZccGFyDQpccGFyDQpccGFyDQpccGFyDQotLS0tLSBPcmlnaW5hbCBNZXNzYWdlIC0tLS0tIFxw
YXINCkZyb206IERvdWdsYXMgRy4gRGFuZm9ydGggXHBhcg0KVG86IEJMQUNLQk9YQExJU1RTLk9C
RVJPTi5DSCBccGFyDQpTZW50OiBXZWRuZXNkYXksIE9jdG9iZXIgMTMsIDIwMTAgMTI6MDMgQU1c
cGFyDQpTdWJqZWN0OiBbQkxBQ0tCT1hdIEV4cG9ydGVkIGNvbW1lbnRzXHBhcg0KXHBhcg0KXHBh
cg0KSW4gRG9jdS9CQi1SdWxlcyB3ZSBmaW5kXHBhcg0KXHBhcg0KIjUgQ29tbWVudHNccGFyDQpc
cGFyDQpDb21tZW50cyB3aGljaCBhcmUgcGFydCBvZiBhbiBpbnRlcmZhY2UgZGVzY3JpcHRpb24g
KHJhdGhlciB0aGFuIGEgbWVyZSBpbXBsZW1lbnRhdGlvbiBkZXNjcmlwdGlvbikgXHBhcg0KaGF2
ZSBhZGRpdGlvbmFsIGFzdGVyaXNrcywgYSBraW5kIG9mICJleHBvcnQgbWFyayIgZm9yIGNvbW1l
bnRzLCBlLmcuICAoKiogZ3VhcmQgZm9yIHh5eiBjb21tYW5kICoqKSJccGFyDQpccGFyDQpJIGlu
dGVycHJldCB0aGF0IHRvIG1lYW4gdGhhdCAgIigqKiBleHBvcnQgbWUhICoqKSIgd291bGQgcHV0
IHRoZSB0ZXh0ICJleHBvcnQgbWUhIiBpbnRvIHRoZSBkZWZpbml0aW9uXHBhcg0KZmlsZSBvZiBh
IG1vZHVsZSAoaS5lLiB0eXBpbmcgQ3RybC1EIHdvdWxkIHNob3cgdGhhdCB0ZXh0IGluIHRoZSBk
aXNwbGF5ZWQgZmlsZSksIGhvd2V2ZXIgdGhhdFxwYXINCmRvZXMgbm90IG9jY3VyLlxwYXINClxw
YXINCkFtIEkgbWlzcmVhZGluZyB0aGF0IG9yIGlzIHRoZXJlIHNvbWV0aGluZyBlbHNlIG9uZSBu
ZWVkcyB0byBkbyBpbiBvcmRlciB0byBleHBvcnQgYSBjb21tZW50P1xwYXINClxwYXINCi1Eb3Vn
IERhbmZvcnRoXHBhcg0KXHBhcg0KXHBhcg0KXHBhcg0KLS0tLSBUbyB1bnN1YnNjcmliZSwgc2Vu
ZCBhIG1lc3NhZ2Ugd2l0aCBib2R5ICJTSUdOT0ZGIEJMQUNLQk9YIiB0byBMSVNUU0VSVkBMSVNU
Uy5PQkVST04uQ0hccGFyDQpccGFyDQpccGFyDQotLS0tXHBhcg0KVG8gdW5zdWJzY3JpYmUsIHNl
bmQgYSBtZXNzYWdlIHdpdGggYm9keSAiU0lHTk9GRiBCTEFDS0JPWCIgdG8gTElTVFNFUlZATElT
VFMuT0JFUk9OLkNIfX0AICAgIA==
----boundary-LibPST-iamunique-220933718_-_---

Received on Wed Oct 13 2010 - 01:43:33 UTC