Re: [BLACKBOX] Exported comments

From: [at]} <Wojtek>
Date: Tue, 12 Oct 2010 20:24:09 -0400

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

Exported comments used to work under Oberon System V4. Not sure about S3.
I once heard that Ominc intended to implement the same feature under
Blackbox, but ran out of steam. The documentation still reflects the
original intent.

The fine print is the following: there were two ways to produce the
Definition under Oberon System. The standard tool read the .Sym file.
Exported comments were not part of that file. However, there was another
tool named Def (if I still remember right) and that tool processed the
text file. It would spit a Defintion which looked much the same as the
"proper defintion", but it would include the exported comments.

I used this feature quite a bit in good old days when I still used the
Oberon System.

Wojtek

On Wed, 13 Oct 2010, Josef Templ wrote:

> 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
> 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
>
>

----
To unsubscribe, send a message with body "SIGNOFF BLACKBOX" to LISTSERV{([at]})nowhere.xy----boundary-LibPST-iamunique-708539447_-_-
Content-type: application/rtf
Content-transfer-encoding: base64
Content-Disposition: attachment; filename="rtf-body.rtf"
e1xydGYxXGFuc2lcYW5zaWNwZzEyNTJcZnJvbXRleHQgXGRlZmYwe1xmb250dGJsDQp7XGYwXGZz
d2lzcyBBcmlhbDt9DQp7XGYxXGZtb2Rlcm4gQ291cmllciBOZXc7fQ0Ke1xmMlxmbmlsXGZjaGFy
c2V0MiBTeW1ib2w7fQ0Ke1xmM1xmbW9kZXJuXGZjaGFyc2V0MCBDb3VyaWVyIE5ldzt9fQ0Ke1xj
b2xvcnRibFxyZWQwXGdyZWVuMFxibHVlMDtccmVkMFxncmVlbjBcYmx1ZTI1NTt9DQpcdWMxXHBh
cmRccGxhaW5cZGVmdGFiMzYwIFxmMFxmczIwIEV4cG9ydGVkIGNvbW1lbnRzIHVzZWQgdG8gd29y
ayB1bmRlciBPYmVyb24gU3lzdGVtIFY0LiBOb3Qgc3VyZSBhYm91dCBTMy4gXHBhcg0KSSBvbmNl
IGhlYXJkIHRoYXQgT21pbmMgaW50ZW5kZWQgdG8gaW1wbGVtZW50IHRoZSBzYW1lIGZlYXR1cmUg
dW5kZXIgXHBhcg0KQmxhY2tib3gsIGJ1dCByYW4gb3V0IG9mIHN0ZWFtLiBUaGUgZG9jdW1lbnRh
dGlvbiBzdGlsbCByZWZsZWN0cyB0aGUgXHBhcg0Kb3JpZ2luYWwgaW50ZW50LlxwYXINClxwYXIN
ClRoZSBmaW5lIHByaW50IGlzIHRoZSBmb2xsb3dpbmc6IHRoZXJlIHdlcmUgdHdvIHdheXMgdG8g
cHJvZHVjZSB0aGUgXHBhcg0KRGVmaW5pdGlvbiB1bmRlciBPYmVyb24gU3lzdGVtLiBUaGUgc3Rh
bmRhcmQgdG9vbCByZWFkIHRoZSAuU3ltIGZpbGUuIFxwYXINCkV4cG9ydGVkIGNvbW1lbnRzIHdl
cmUgbm90IHBhcnQgb2YgdGhhdCBmaWxlLiBIb3dldmVyLCB0aGVyZSB3YXMgYW5vdGhlciBccGFy
DQp0b29sIG5hbWVkIERlZiAoaWYgSSBzdGlsbCByZW1lbWJlciByaWdodCkgYW5kIHRoYXQgdG9v
bCBwcm9jZXNzZWQgdGhlIFxwYXINCnRleHQgZmlsZS4gSXQgd291bGQgc3BpdCBhIERlZmludGlv
biB3aGljaCBsb29rZWQgbXVjaCB0aGUgc2FtZSBhcyB0aGUgXHBhcg0KInByb3BlciBkZWZpbnRp
b24iLCBidXQgaXQgd291bGQgaW5jbHVkZSB0aGUgZXhwb3J0ZWQgY29tbWVudHMuXHBhcg0KXHBh
cg0KSSB1c2VkIHRoaXMgZmVhdHVyZSBxdWl0ZSBhIGJpdCBpbiBnb29kIG9sZCBkYXlzIHdoZW4g
SSBzdGlsbCB1c2VkIHRoZSBccGFyDQpPYmVyb24gU3lzdGVtLlxwYXINClxwYXINCldvanRla1xw
YXINClxwYXINCk9uIFdlZCwgMTMgT2N0IDIwMTAsIEpvc2VmIFRlbXBsIHdyb3RlOlxwYXINClxw
YXINCj4gaW50ZXJlc3RpbmcgaW5kZWVkLiBUaGVyZSBtdXN0IGJlIHNvbWUgb3RoZXIgdG9vbCB0
aGF0IGlzIHVzZWQgYnkgb21jIGZvciBccGFyDQo+IGNyZWF0aW5nXHBhcg0KPiBBUEkgZG9jdSBm
cm9tIGEgc291cmNlIGZpbGUuIFRoZSBkZWZpbml0aW9uIGlzIGNyZWF0ZWQgZnJvbSB0aGUgU3lt
Ym9sZmlsZSxccGFyDQo+IHdoaWNoIGRvZXMgbm90IGNvbnRhaW4gY29tbWVudHMuXHBhcg0KPlxw
YXINCj4gQWxzbyBpbnRlcmVzdGluZyBpbiAnRG9jdW1lbnRhdGlvbiBDb252ZW50aW9ucyc6XHBh
cg0KPlxwYXINCj4gSW4gQmxhY2tCb3gsIGFsbCBwcm9jZWR1cmVzIHdob3NlIG5hbWVzIHN0YXJ0
IHdpdGggIkluaXQiIG1heSBiZSBjYWxsZWQgb25seSBccGFyDQo+IG9uY2UgcGVyIG9iamVjdCwg
aS5lLiwgdGhleSBhcmUgInNuYXBweSIuXHBhcg0KPiBJIGRpZCBub3Qga25vdyB0aGF0LiBJcyBp
dCB0cnVlPyBPciBkb3dzIGl0IGFwcGx5IG9ubHkgdG8gdGhlIHByZXNlbnRlZCBccGFyDQo+IGV4
YW1wbGUuXHBhcg0KPiBJbiB0aGlzIGNhc2UgdGhlIHRleHQgaXMgbWlzbGVhZGluZy5ccGFyDQo+
XHBhcg0KPlxwYXINCj4gLSBKb3NlZlxwYXINCj5ccGFyDQo+XHBhcg0KPlxwYXINCj4gLS0tLS0g
T3JpZ2luYWwgTWVzc2FnZSAtLS0tLSBGcm9tOiBEb3VnbGFzIEcuIERhbmZvcnRoIFRvOiBccGFy
DQo+IEJMQUNLQk9YQExJU1RTLk9CRVJPTi5DSCBTZW50OiBXZWRuZXNkYXksIE9jdG9iZXIgMTMs
IDIwMTAgMTI6MDMgQU1ccGFyDQo+IFN1YmplY3Q6IFtCTEFDS0JPWF0gRXhwb3J0ZWQgY29tbWVu
dHNccGFyDQo+XHBhcg0KPlxwYXINCj4gSW4gRG9jdS9CQi1SdWxlcyB3ZSBmaW5kXHBhcg0KPlxw
YXINCj4gIjUgQ29tbWVudHNccGFyDQo+XHBhcg0KPiBDb21tZW50cyB3aGljaCBhcmUgcGFydCBv
ZiBhbiBpbnRlcmZhY2UgZGVzY3JpcHRpb24gKHJhdGhlciB0aGFuIGEgbWVyZSBccGFyDQo+IGlt
cGxlbWVudGF0aW9uIGRlc2NyaXB0aW9uKSBoYXZlIGFkZGl0aW9uYWwgYXN0ZXJpc2tzLCBhIGtp
bmQgb2YgImV4cG9ydCBccGFyDQo+IG1hcmsiIGZvciBjb21tZW50cywgZS5nLiAgKCoqIGd1YXJk
IGZvciB4eXogY29tbWFuZCAqKikiXHBhcg0KPlxwYXINCj4gSSBpbnRlcnByZXQgdGhhdCB0byBt
ZWFuIHRoYXQgICIoKiogZXhwb3J0IG1lISAqKikiIHdvdWxkIHB1dCB0aGUgdGV4dCBccGFyDQo+
ICJleHBvcnQgbWUhIiBpbnRvIHRoZSBkZWZpbml0aW9uXHBhcg0KPiBmaWxlIG9mIGEgbW9kdWxl
IChpLmUuIHR5cGluZyBDdHJsLUQgd291bGQgc2hvdyB0aGF0IHRleHQgaW4gdGhlIGRpc3BsYXll
ZCBccGFyDQo+IGZpbGUpLCBob3dldmVyIHRoYXRccGFyDQo+IGRvZXMgbm90IG9jY3VyLlxwYXIN
Cj5ccGFyDQo+IEFtIEkgbWlzcmVhZGluZyB0aGF0IG9yIGlzIHRoZXJlIHNvbWV0aGluZyBlbHNl
IG9uZSBuZWVkcyB0byBkbyBpbiBvcmRlciB0byBccGFyDQo+IGV4cG9ydCBhIGNvbW1lbnQ/XHBh
cg0KPlxwYXINCj4gLURvdWcgRGFuZm9ydGhccGFyDQo+XHBhcg0KPlxwYXINCj5ccGFyDQo+IC0t
LS0gVG8gdW5zdWJzY3JpYmUsIHNlbmQgYSBtZXNzYWdlIHdpdGggYm9keSAiU0lHTk9GRiBCTEFD
S0JPWCIgdG8gXHBhcg0KPiBMSVNUU0VSVkBMSVNUUy5PQkVST04uQ0hccGFyDQo+XHBhcg0KPlxw
YXINCj4gLS0tLVxwYXINCj4gVG8gdW5zdWJzY3JpYmUsIHNlbmQgYSBtZXNzYWdlIHdpdGggYm9k
eSAiU0lHTk9GRiBCTEFDS0JPWCIgdG8gXHBhcg0KPiBMSVNUU0VSVkBMSVNUUy5PQkVST04uQ0hc
cGFyDQo+XHBhcg0KPlxwYXINClxwYXINClxwYXINCi0tLS1ccGFyDQpUbyB1bnN1YnNjcmliZSwg
c2VuZCBhIG1lc3NhZ2Ugd2l0aCBib2R5ICJTSUdOT0ZGIEJMQUNLQk9YIiB0byBMSVNUU0VSVkBM
SVNUUy5PQkVST04uQ0hccGFyDQp9
----boundary-LibPST-iamunique-708539447_-_---

Received on Wed Oct 13 2010 - 02:24:09 UTC