changeset 58:f2c5f1fca9a7

added javadoc capability
author Robert McIntyre <rlm@mit.edu>
date Sat, 03 Dec 2011 21:53:52 -0600
parents 19831877eaed
children 5afa49c5a7d3
files .hgignore build.xml src/ca/randelshofer/AVIOutputStream.java
diffstat 3 files changed, 13 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
     1.1 --- a/.hgignore	Sat Dec 03 19:51:47 2011 -0600
     1.2 +++ b/.hgignore	Sat Dec 03 21:53:52 2011 -0600
     1.3 @@ -9,4 +9,5 @@
     1.4  lib*
     1.5  .ant*
     1.6  output/*
     1.7 -
     1.8 +docs/*
     1.9 +releases/*
     2.1 --- a/build.xml	Sat Dec 03 19:51:47 2011 -0600
     2.2 +++ b/build.xml	Sat Dec 03 21:53:52 2011 -0600
     2.3 @@ -4,6 +4,7 @@
     2.4    <property name="build" value="build"/>
     2.5    <property name="src" value="src"/>
     2.6    <property name="dist" value="dist"/>
     2.7 +  <property name="docs" value="docs"/>
     2.8    <property name="lib"  value="lib"/>
     2.9  
    2.10  
    2.11 @@ -35,7 +36,7 @@
    2.12  	   includeantruntime="false"/>
    2.13    </target>
    2.14  
    2.15 -  <target name="dist" depends="compile" >
    2.16 +  <target name="dist" depends="compile,javadoc" >
    2.17      <mkdir dir="${dist}"/> 
    2.18      <jar jarfile="${dist}/jmeCapture.jar">
    2.19  	 <fileset dir="${src}"/>
    2.20 @@ -43,11 +44,18 @@
    2.21      </jar>
    2.22    </target>
    2.23  
    2.24 -  <target name="clean" > 
    2.25 +  <target name="clean"> 
    2.26      <delete dir="${build}"/> 
    2.27      <delete dir="${dist}"/> 
    2.28 +    <delete dir="${docs}"/>
    2.29    </target> 
    2.30  
    2.31 +  <target name="javadoc">
    2.32 +    <mkdir dir="${docs}"/>
    2.33 +    <javadoc sourcepath="${src}"
    2.34 +	     classpathref="classpath"
    2.35 +	     destdir="${docs}"/>
    2.36 +  </target>
    2.37  
    2.38  </project>
    2.39  
     3.1 --- a/src/ca/randelshofer/AVIOutputStream.java	Sat Dec 03 19:51:47 2011 -0600
     3.2 +++ b/src/ca/randelshofer/AVIOutputStream.java	Sat Dec 03 21:53:52 2011 -0600
     3.3 @@ -442,7 +442,7 @@
     3.4       *
     3.5       * @param file the output file
     3.6       * @param format Selects an encoder for the video format.
     3.7 -     * @param bitsPerPixel the number of bits per pixel.
     3.8 +     * 
     3.9       * @exception IllegalArgumentException if videoFormat is null or if
    3.10       * frame rate is <= 0
    3.11       */