Function to get doc-strings from user-defined functions

[satya]

SKILL seems to support elisp-style docstrings. But I haven't found a
way of accessing them in the CIW. Does any one know howto get them in
CIW?

Thanks,
Satya

 

[Andrew Beckett]

On 29 Sep 2006 09:58:59 -0700, "satya" <qufgmx@gmail.com> wrote:

SKILL seems to support elisp-style docstrings. But I haven't found a
way of accessing them in the CIW. Does any one know howto get them in
CIW?

Thanks,
Satya

Satya,

This is no longer supported. Many years ago, the "help" function used to look at
this information for a function and print it - nowadays help looks in the finder
database.

In fact now if you run SKILL Lint on code that has a documentation string (which
was a literal text string appearing as the first statement in the body of the
function definition), it reports:

INFO (FDOC): code.il, line 1 : _fdoc no longer supported.

Regards,

Andrew.
--
Andrew Beckett
Principal European Technology Leader
Cadence Design Systems, UK.

 

[satya]

Andrew Beckett wrote:

On 29 Sep 2006 09:58:59 -0700, "satya" <qufgmx@gmail.com> wrote:

SKILL seems to support elisp-style docstrings. But I haven't found a
way of accessing them in the CIW. Does any one know howto get them in
CIW?

This is no longer supported. Many years ago, the "help" function used to look at
this information for a function and print it - nowadays help looks in the finder
database.

In fact now if you run SKILL Lint on code that has a documentation string (which
was a literal text string appearing as the first statement in the body of the
function definition), it reports:

INFO (FDOC): code.il, line 1 : _fdoc no longer supported.

Andrew,

Thanks for that clarification. So what is the recommended method for
online documentation on
user-defined functions these days?

Satya

 

[Andrew Beckett]

On 5 Oct 2006 06:33:18 -0700, "satya" <qufgmx@gmail.com> wrote:

Andrew Beckett wrote:
On 29 Sep 2006 09:58:59 -0700, "satya" <qufgmx@gmail.com> wrote:

SKILL seems to support elisp-style docstrings. But I haven't found a
way of accessing them in the CIW. Does any one know howto get them in
CIW?

This is no longer supported. Many years ago, the "help" function used to look at
this information for a function and print it - nowadays help looks in the finder
database.

In fact now if you run SKILL Lint on code that has a documentation string (which
was a literal text string appearing as the first statement in the body of the
function definition), it reports:

INFO (FDOC): code.il, line 1 : _fdoc no longer supported.

Andrew,

Thanks for that clarification. So what is the recommended method for
online documentation on
user-defined functions these days?

Satya

It's possible to add to the cdsFinder database - I think this is covered in the
documentation.

Then it would work with help() too.

Andrew.
--
Andrew Beckett
Principal European Technology Leader
Cadence Design Systems, UK.

 

[satya]

Andrew Beckett wrote:

It's possible to add to the cdsFinder database - I think this is covered in the
documentation.

I knew there had to be some use for the documentation Thanks a lot
for the pointer. I can now get help on my functions.

Satya