[cig-commits] commit: Filling out meta file details for InputFormats.

[Mercurial]

changeset:   68:cdd45a53b88e
user:        RobertTurnbull
date:        Fri Aug 08 03:43:25 2008 +0000
files:       Base/src/InputFormat.meta InputFormats/src/InputPPM.meta InputFormats/src/InputTIFF.c InputFormats/src/InputTIFF.meta
description:
Filling out meta file details for InputFormats.

See http://csd.vpac.org/trac/CM/AuScope/AuScopeDoc/ticket/139


diff -r 44d00344570e -r cdd45a53b88e Base/src/InputFormat.meta
--- a/Base/src/InputFormat.meta	Fri Aug 08 03:16:23 2008 +0000
+++ b/Base/src/InputFormat.meta	Fri Aug 08 03:43:25 2008 +0000
@@ -13,7 +13,7 @@
 <param name="Parent">Stg_Component</param>
 <param name="Reference">N/A.</param>
 <param name="Summary">...</param>
-<param name="Description">An abstract class to setup an interface to read in images to be used in lucDrawingObjects.</param>
+<param name="Description">An abstract class to setup an interface to read in images to be used in lucDrawingObjects. Each concrete Input Format class should be added to the lucInputFormat_Register which works out which lucInputFormat to use when opening an image through its extension. e.g. Image.ppm will be opened by the lucInputPPM class.</param>
 
 <!--Now the interesting stuff-->
 
diff -r 44d00344570e -r cdd45a53b88e InputFormats/src/InputPPM.meta
--- a/InputFormats/src/InputPPM.meta	Fri Aug 08 03:16:23 2008 +0000
+++ b/InputFormats/src/InputPPM.meta	Fri Aug 08 03:43:25 2008 +0000
@@ -3,7 +3,7 @@
 <StGermainData xmlns="http://www.vpac.org/StGermain/XML_IO_Handler/Jun2003">
 
 <param name="Name">lucInputPPM</param>
-<param name="Author">...</param>
+<param name="Author">Robert Turnbull</param>
 <param name="Organisation">MCC</param>
 <param name="Project">gLucifer</param>
 <param name="Location">./gLucifer/InputFormats/src/</param>
@@ -11,21 +11,17 @@
 <param name="Copyright">Copyright (c) 2005, Monash Cluster Computing</param>
 <param name="License">http://www.opensource.org/licenses/bsd-license.php</param>
 <param name="Parent">lucInputFormat</param>
-<param name="Reference">...</param>
+<param name="Reference">http://netpbm.sourceforge.net/doc/ppm.html</param>
 <param name="Summary">...</param>
-<param name="Description">...</param>
+<param name="Description">This reads PPM files, ready to be used by another component. This component is placed on the lucInputFormat_Register so that any files with a .ppm extension will use this component to open.</param>
 
 <!--Now the interesting stuff-->
-
-
 <list name="Params">
-
 </list>
 
 <list name="Dependencies">
-
 </list>
 <!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example">N/A</param>
 
 </StGermainData>
diff -r 44d00344570e -r cdd45a53b88e InputFormats/src/InputTIFF.c
--- a/InputFormats/src/InputTIFF.c	Fri Aug 08 03:16:23 2008 +0000
+++ b/InputFormats/src/InputTIFF.c	Fri Aug 08 03:43:25 2008 +0000
@@ -165,7 +165,8 @@ void _lucInputTIFF_Destroy( void* InputF
 
 lucPixel* _lucInputTIFF_Input( void* inputFormat, Name imageName, Pixel_Index *width, Pixel_Index* height ){
 
-	/*Using Sam Leffler's libtiff library */
+	/* Using Sam Leffler's libtiff library 
+	 * http://www.remotesensing.org/libtiff/ */
 	TIFFRGBAImage  img;
 	uint32*        raster;
 	size_t         npixels;
diff -r 44d00344570e -r cdd45a53b88e InputFormats/src/InputTIFF.meta
--- a/InputFormats/src/InputTIFF.meta	Fri Aug 08 03:16:23 2008 +0000
+++ b/InputFormats/src/InputTIFF.meta	Fri Aug 08 03:43:25 2008 +0000
@@ -3,7 +3,7 @@
 <StGermainData xmlns="http://www.vpac.org/StGermain/XML_IO_Handler/Jun2003">
 
 <param name="Name">lucInputTIFF</param>
-<param name="Author">...</param>
+<param name="Author">Cecile Duboz</param>
 <param name="Organisation">MCC</param>
 <param name="Project">gLucifer</param>
 <param name="Location">./gLucifer/InputFormats/src/</param>
@@ -11,13 +11,11 @@
 <param name="Copyright">Copyright (c) 2005, Monash Cluster Computing</param>
 <param name="License">http://www.opensource.org/licenses/bsd-license.php</param>
 <param name="Parent">lucInputFormat</param>
-<param name="Reference">...</param>
+<param name="Reference">http://www.remotesensing.org/libtiff/</param>
 <param name="Summary">...</param>
-<param name="Description">...</param>
+<param name="Description">This reads TIFF files, ready to be used by another component. This component is placed on the lucInputFormat_Register so that any files with a .ppm extension will use this component to open. This component is only compiled if you have libtiff installed.</param>
 
 <!--Now the interesting stuff-->
-
-
 <list name="Params">
 
 </list>
@@ -26,6 +24,6 @@
 
 </list>
 <!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example">N/A</param>
 
 </StGermainData>