doxygen or similar for skill

[danmc]

Does anyone have a favorite way for putting documentation for skill
functions inline with the code? I'm thinking of something similar to
what doxygen provides for c programs.

The reason I'm looking for this is that over the years I have
developed many skill procedures but my documentation has been somewhat
lacking. You have to search through the .il files and read comments
and that makes it difficult for others to see what utilities I have
available and how to use them.

I have found in the past with other projects that keeping the
documentation somewhere else entirely leads to out of date and
incomplete documentation in a hurry.

If there is a good system for doing docs inline with skill I'd rather
use that than reinvent the wheel.

Thanks
-Dan

 

[Riad KACED]

Hi Dan,

There is no such utility with Skill as far as I know. I did cross-
check my Cadence's Orange Book (The skill quick reference book) this
evening and there is no word about such a thing I'm afraid. I might be
wrong though ...

The simplest solution I could see for this is maybe to ask Cadence to
get the POD documentation format recognized by the skill compiler.
Something similar to perl/perldoc would be great.

Otherwise, it would very easy to write a kind of 'perldoc' to parse a
skill document and output the comments. A little perl script will do
this basic task.
But like you, I don't like to reinvent the wheel, so let's see what
the experts think about it.

Cheers,
Riad.

 

[danmc]

On Sep 14, 5:56 pm, Riad KACED <riad.ka...@gmail.com> wrote:

Hi Dan,

There is no such utility with Skill as far as I know. I did cross-
check my Cadence's Orange Book (The skill quick reference book) this
evening and there is no word about such a thing I'm afraid. I might be
wrong though ...

The simplest solution I could see for this is maybe to ask Cadence to
get the POD documentation format recognized by the skill compiler.
Something similar to perl/perldoc would be great.

Otherwise, it would very easy to write a kind of 'perldoc' to parse a
skill document and output the comments. A little perl script will do
this basic task.
But like you, I don't like to reinvent the wheel, so let's see what
the experts think about it.

Cheers,
Riad.

I may play around with POD embedded in a multi-line comment. I just
hope emacs skill-mode doesn't try to
keep formatting my POD stuff in a bad way (like indenting the leading
=head1).

-Dan

 

[danmc]

On Sep 22, 10:22 pm, danmc <s...@mcmahill.net> wrote:

On Sep 14, 5:56 pm, Riad KACED <riad.ka...@gmail.com> wrote:



Hi Dan,

There is no such utility with Skill as far as I know. I did cross-
check my Cadence's Orange Book (The skill quick reference book) this
evening and there is no word about such a thing I'm afraid. I might be
wrong though ...

The simplest solution I could see for this is maybe to ask Cadence to
get the POD documentation format recognized by the skill compiler.
Something similar to perl/perldoc would be great.

Otherwise, it would very easy to write a kind of 'perldoc' to parse a
skill document and output the comments. A little perl script will do
this basic task.
But like you, I don't like to reinvent the wheel, so let's see what
the experts think about it.

Cheers,
Riad.

I may play around with POD embedded in a multi-line comment. I just
hope emacs skill-mode doesn't try to
keep formatting my POD stuff in a bad way (like indenting the leading
=head1).

-Dan

ok, so emacs skill-mode isn't that happy with POD, but it sort of
works. I'll probably give this a shot for a little bit and see if it
seems worth continuing on.

-Dan