Advertisement
If you have a new account but are having problems posting or verifying your account, please email us on hello@boards.ie for help. Thanks :)
Hello all! Please ensure that you are posting a new thread or question in the appropriate forum. The Feedback forum is overwhelmed with questions that are having to be moved elsewhere. If you need help to verify your account contact hello@boards.ie

javadoc... how??

Options
  • 17-12-2009 4:22pm
    #1
    Registered Users Posts: 244 ✭✭


    trying to add documentation to a project im working on but i cant find how to create javadocs... im using netbeans on mac

    the best i can do is get this - Javadoc not found. Either Javadoc documentation for this item does not exist or you have not added specified Javadoc in the Java Platform Manager or the Library Manager.


Comments

  • Registered Users Posts: 2,426 ✭✭✭ressem


    The message you're describing is that given when you've added a library and not specified where to find the relevent javadoc.

    You're creating javadocs for your own code?
    I don't have the mac build, but in this version 6.7.1 on windows, under the run menu there is a "Generate Javadoc" menu item.

    This runs the javadoc-build target in the "build.xml" ant script, created by default when you start a new project in Netbeans.

    If you change the tab in the Navigation Pane from "Projects" to "Files" you'll be able to view the build.xml file. There should be an entry within the file that looks like
    
        <!--
                    JAVADOC SECTION
                -->
        <target depends="init" name="javadoc-build">
            <mkdir dir="${dist.javadoc.dir}"/>
            <javadoc additionalparam="${javadoc.additionalparam}" author="${javadoc.author}" charset="UTF-8" destdir="${dist.javadoc.dir}" docencoding="UTF-8" encoding="${javadoc.encoding.used}" failonerror="true" noindex="${javadoc.noindex}" nonavbar="${javadoc.nonavbar}" notree="${javadoc.notree}" private="${javadoc.private}" source="${javac.source}" splitindex="${javadoc.splitindex}" use="${javadoc.use}" useexternalfile="true" version="${javadoc.version}" windowtitle="${javadoc.windowtitle}">
                <classpath>
                    <path path="${javac.classpath}:${j2ee.platform.classpath}"/>
                </classpath>
                <fileset dir="${src.dir}" excludes="${excludes}" includes="${includes}">
                    <filename name="**/*.java"/>
                </fileset>
                <fileset dir="${build.generated.sources.dir}" erroronmissingdir="false">
                    <include name="**/*.java"/>
                </fileset>
            </javadoc>
        </target>
        <target depends="init,javadoc-build" if="netbeans.home" name="javadoc-browse" unless="no.javadoc.preview">
            <nbbrowse file="${dist.javadoc.dir}/index.html"/>
        </target>
        <target depends="init,javadoc-build,javadoc-browse" description="Build Javadoc." name="javadoc"/>
    
    


  • Registered Users Posts: 244 ✭✭theliam


    ahhh didnt realise what all those

    /**
    * <-documentation here!
    *@...
    */

    bits were...


Advertisement