comp.lang.idl-pvwave archive: archive

Home » Public Forums » archive » IDLDoc Bandwagon

Show: Today's Messages :: Show Polls :: Message Navigator
E-mail to friend

Re: IDLDoc Bandwagon [message #72653 is a reply to message #72510]

Mon, 20 September 2010 21:30

penteado
Messages: 866
Registered: February 2018

Senior Member
Administrator

On Sep 21, 1:20 am, David Fanning <n...@dfanning.com> wrote:
> Yes, I have a question about that. What do you do in the
> case of a large file with many modules? The module I want
> to document is, of course, at the bottom of the file. And
> yet I want the documentation to appear at the top of the
> file. How would you handle something like that?

Maybe with hidden or private tags to suppress the other routines?

> Also, I want to have the copyright notice (as some significant
> amount of text) in the file. What would be the best way to
> handle that? There really isn't a category for that, and
> it seems a little strange to put it someplace like after
> the procedure definition statement (which would follow
> immediately after the documentation) and before the first
> line of code in the procedure.

There is a copyright tag, and it could go on the file-level comments.
Or in an overview file. Am I missing something?

Report message to a moderator

[Message index]

		IDLDoc Bandwagon By: David Fanning on Mon, 20 September 2010 16:48
		Re: IDLDoc Bandwagon By: David Fanning on Tue, 21 September 2010 14:32
		Re: IDLDoc Bandwagon By: Michael Galloy on Tue, 21 September 2010 14:12
		Re: IDLDoc Bandwagon By: David Fanning on Tue, 21 September 2010 10:17
		Re: IDLDoc Bandwagon By: Michael Galloy on Tue, 21 September 2010 07:16
		Re: IDLDoc Bandwagon By: Michael Galloy on Tue, 21 September 2010 07:02
		Re: IDLDoc Bandwagon By: David Fanning on Mon, 20 September 2010 21:53
		Re: IDLDoc Bandwagon By: penteado on Mon, 20 September 2010 21:30
		Re: IDLDoc Bandwagon By: penteado on Mon, 20 September 2010 21:23
		Re: IDLDoc Bandwagon By: David Fanning on Mon, 20 September 2010 21:20
		Re: IDLDoc Bandwagon By: penteado on Mon, 20 September 2010 21:16
		Re: IDLDoc Bandwagon By: Michael Galloy on Mon, 20 September 2010 20:54
		Re: IDLDoc Bandwagon By: penteado on Mon, 20 September 2010 18:29
		Re: IDLDoc Bandwagon By: penteado on Mon, 20 September 2010 18:27

Previous Topic:	The variable shellCmd is not defined
Next Topic:	Coyote and Catalyst Libraries Available on SVN Repository

-=] Back to Top [=-

[ Syndicate this forum (XML) ] [

] [

]

Current Time: Wed Dec 03 18:52:11 PST 2025

Total time taken to generate the page: 1.19936 seconds