[lucy-commits] svn commit: r1305578 - in /lucy/trunk/clownfish/src: CFCClass.h CFCFile.h

[nw...@apache.org]

Author: nwellnhof
Date: Mon Mar 26 20:49:09 2012
New Revision: 1305578

URL: http://svn.apache.org/viewvc?rev=1305578&view=rev
Log:
Document new params

Modified:
    lucy/trunk/clownfish/src/CFCClass.h
    lucy/trunk/clownfish/src/CFCFile.h

Modified: lucy/trunk/clownfish/src/CFCClass.h
URL: http://svn.apache.org/viewvc/lucy/trunk/clownfish/src/CFCClass.h?rev=1305578&r1=1305577&r2=1305578&view=diff
==============================================================================
--- lucy/trunk/clownfish/src/CFCClass.h (original)
+++ lucy/trunk/clownfish/src/CFCClass.h Mon Mar 26 20:49:09 2012
@@ -55,6 +55,7 @@ struct CFCVariable;
  * @param is_inert Should be true if the class is inert, i.e. cannot be
  * instantiated.
  * @param is_final Should be true if the class is final.
+ * @param is_included Should be true if the class is from an include dir.
  */
 CFCClass*
 CFCClass_create(struct CFCParcel *parcel, const char *exposure,

Modified: lucy/trunk/clownfish/src/CFCFile.h
URL: http://svn.apache.org/viewvc/lucy/trunk/clownfish/src/CFCFile.h?rev=1305578&r1=1305577&r2=1305578&view=diff
==============================================================================
--- lucy/trunk/clownfish/src/CFCFile.h (original)
+++ lucy/trunk/clownfish/src/CFCFile.h Mon Mar 26 20:49:09 2012
@@ -37,6 +37,7 @@ struct CFCClass;
  * source_class is "Foo::Bar", that implies that the source file could be
  * found at 'Foo/Bar.cfh' within the source directory and that the output C
  * header file should be 'Foo/Bar.h' within the target include directory.
+ * @param source_dir The source directory in which the file was found.
 */
 CFCFile*
 CFCFile_new(const char *source_class, const char *source_dir);