Class ExtractPyAPIDoc

  • All Implemented Interfaces:
    DocumentationProvider

    public class ExtractPyAPIDoc
    extends Documentation
    Class used to extract Blender's python API documentation received by executing the rna_info.py script. It is recommended to use the shell script extract-pyapi-docs.sh for this task. The shell script is located in org.cakelab.blender.dnadoc repository.
    Author:
    homac
    • Constructor Detail

      • ExtractPyAPIDoc

        public ExtractPyAPIDoc​(java.io.File file,
                               java.lang.String version,
                               java.io.File out)
                        throws java.io.IOException
        Throws:
        java.io.IOException
    • Method Detail

      • addFieldDoc

        public void addFieldDoc​(java.lang.String[] baseStructNames,
                                java.lang.String structName,
                                java.lang.String memberName,
                                java.lang.String documentation)
      • main

        public static void main​(java.lang.String[] args)
                         throws java.io.IOException
        Throws:
        java.io.IOException