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 **)
and yet such comments are not written to the client interface (CTRL-D)
(at least not for me). Is there some flag that can be set to force this to happen?
I am not aware of any tool that makes use of this form of comments.
It is well possible that ominc envisioned a tool like JavaDoc that creates
a documentation file out of the commented source code, but I think
that does not exist or may be it existed inside ominc but has not been disclosed.
Josef Templ wrote:I am not aware of any tool that makes use of this form of comments.
It is well possible that ominc envisioned a tool like JavaDoc that creates
a documentation file out of the commented source code, but I think
that does not exist or may be it existed inside ominc but has not been disclosed.
- Josef
Probably true, however, I see many files with the (**...**) construct. Why do this if it has no functionality?
Sorry, I know this was discussed. I just don't know where.
(How can I search the whole Board index?)
I have an extensive module called MyVectors for which it would be very useful
to see the (** comments **) exported for each procedure in the sym file.
As it is now I must go back and open the source code to see them.
As I remember Josef hypothesized that Oberon Microsystems intended to add
such a feature but never got around to it.
I would like to see the exported comments generated when a module is compiled
(and not by some other add-on utility). That would mean knowing how a sym file
is generated and getting into the guts of that process.
DGDanforth wrote:Robert, thank you for the pointer to here (was that from memory or do you have a search algorithm?)
Both!
I have a vague memory of seeing this recently - I probably moved it to the deferred category as part of a recent clean-up of this site.
I tried an "Advanced search" for "(**", but that did not work as "*" is treated as a wildcard and I don't know if there is an escape character.
I then did a (quick) manual search - it did not take long.
You can type any text (like "export comment") in the search box and you will get results as expected.
The problem with the search box is with special characters like (**.
It is also not possible to search for an issue by a string of the form "issue-#106".
The # is dropped and the rest ("issue-106") is not found.
Searching for "issue 106" finds something close to the intended search.
There may be tricks but there are certainly limits. phpBB searches only for words in the index. So it depends
on the index if a term is found or not. Some words or special chars seem not to be indexed.
Maybe somebody has read the docu more carefully and finds a solution.
