Maxon Developers Maxon Developers
    • Documentation
      • Cinema 4D Python API
      • Cinema 4D C++ API
      • Cineware API
      • ZBrush GoZ API
      • Code Examples on Github
    • Forum
    • Downloads
    • Support
      • Support Procedures
      • Registered Developer Program
      • Plugin IDs
      • Contact Us
    • Categories
      • Overview
      • News & Information
      • Cinema 4D SDK Support
      • Cineware SDK Support
      • ZBrush 4D SDK Support
      • Bugs
      • General Talk
    • Unread
    • Recent
    • Tags
    • Users
    • Login

    Using c4dpy to show Class Documentation?

    Cinema 4D SDK
    3
    3
    886
    Loading More Posts
    • Oldest to Newest
    • Newest to Oldest
    • Most Votes
    Reply
    • Reply as topic
    Log in to reply
    This topic has been deleted. Only users with topic management privileges can see it.
    • dskeithbuckD
      dskeithbuck
      last edited by dskeithbuck

      Is it possible to have c4dpy show documenation for classes?

      Functions Docs:
      0_1546029879883_FunctionDocs.jpg
      Lots of helpful information!

      Class Docs:
      0_1546029755835_ClassDocs.jpg
      A bit anemic by comparison.

      Specifically, I'm looking for a description of what a class is generally used for. I would also love it if there was some way to have autocomplete list the functions in an ObjectData class that need to be overloaded to get a working plugin.

      Are these things supported and I just don't have VS Code configured properly? If not, please consider this a request to add them in the future.
      Thanks,

      Donovan

      1 Reply Last reply Reply Quote 0
      • M
        m_adam
        last edited by

        Hi Donovan, unfortunately currently there is no docstring in our class definition so it's why VS code shows nothing about them.

        Regarding the overloaded stuff, there is no way for doing it right now, but you could define your own snippets for each plugin type.

        I can't promise you anything, but this is something we definitely consider.

        Thanks a lot for your feedback and I wish you a happy new year!
        Cheers,
        Maxime.

        MAXON SDK Specialist

        Development Blog, MAXON Registered Developer

        1 Reply Last reply Reply Quote 0
        • dskeithD
          dskeith
          last edited by

          Hi Maxime - thank you very much for the response, and I'm glad to hear you're considering it for the future.

          1 Reply Last reply Reply Quote 0
          • First post
            Last post