Function to get doc-strings from user-defined functions

Discussion in 'Cadence' started by satya, Sep 29, 2006.

  1. satya

    satya Guest

    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, Sep 29, 2006
    #1
  2. 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, Oct 2, 2006
    #2
  3. satya

    satya Guest

    Andrew,

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

    Satya
     
    satya, Oct 5, 2006
    #3
  4. 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, Oct 6, 2006
    #4
  5. satya

    satya Guest

    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
     
    satya, Oct 9, 2006
    #5
Ask a Question

Want to reply to this thread or ask your own question?

You'll need to choose a username for the site, which only take a couple of moments (here). After that, you can post your question and our members will help you out.