Generate or export Apexdoc

Issue #1028 resolved
Riadh Mankai created an issue

Maybe this is already supported, but looked for it and I could not find it. It would nice toto export the custom ApexDoc. Is that possible? I tried to generate JavaDoc through Tools | Generate JavaDoc, but got an error (could not locate my JDK path). But I guess ApexDoc and JavaDoc are 2 different things.

Comments (6)

  1. Scott Wells repo owner

    Riadh, as you've determined, ApexDoc and JavaDoc are not the same thing. While Illuminated Cloud supports ApexDoc authoring and quick documentation rendering, it doesn't currently support bulk generation of standalone docs. You can install ApexDoc (I recommend the SfApexDoc derivative build) and run it from the command-line. You can also register that as an external tool in IntelliJ IDEA/WebStorm if you'd like a more integrated experience. I hope this helps!

  2. Scott Wells repo owner

    I've had several folks request a more integrated experience. I will keep this request open to track any progress toward that goal.

  3. Rick Nendza

    Please please please 🙂 looking for an easy tool to export apex doc as a shaming mechanism for my clients lazy devs. Still seems no simple way other then 3rd party command line.

  4. Scott Wells repo owner

    Rick, it's unlikely that this will be fully integrated in the near future, but I and other have had good success registering the CLI as an external tool. Here's an example of how I set it up:

    SfApexDoc_Config.png

    The value for Arguments is a bit obscured there, but it's:

    -jar /path/to/SfApexDoc.jar -s relative/path/to/classes -t relative-output-path
    

    You can even map the external tool definition to a shortcut key if you'd like.

    Hopefully that will give you the desired experience.

  5. Log in to comment