Andreas Tscharner avatar Andreas Tscharner committed dd61aa5

Fixed some minor documentatoion errors

Comments (0)

Files changed (2)

src/include/Resource.hxx

  * <tt>-h</tt>: Show the usage of the compiler and quit.\n
  * <tt>-d</tt>: Deny overwrite an existing .rdf file. This parameter is
  * optional and the default is overwriting allowed. If <tt>-d</tt> is set
- * and the file already exists, the compiler exits with an according
- * message.\n
+ * and the file already exists, the compiler exits with an error message.\n
  * <tt>-o \<file\></tt>: Specify the resource output file (.rdf). This
  * parameter is optional. If it is omitted the output file will be the name
  * of the input file, but with .rdf as file extension.\n
  * <tt>-c \<compression type\></tt>: Specify the compression type for the
  * whole .rdf file. Allowed are all compression types that are allowed for a
  * single resource file. These are at the moment:
- * - zLib compression
- * - bzip2 compression
+ * - zLib: zLib compression
+ * - bzip2: bzip2 compression
  *
  * \section liblrc The library liblrc
  * The library consists mainly of two classes: the \link
  *
  * \section example Example
  * A few examples that demonstrates the \c lrc and \c liblrc can be found in
- * the <tt>src\\example</tt> directory.
+ * the <tt>src/example</tt> directory.
  *
  * \author Andreas Tscharner
- * \date 2012-06-10
+ * \date 2013-01-13
  */
 
 

src/include/ResourceManager.hxx

  * \c liblrc
  *
  * \author Andreas Tscharner
- * \date 2012-05-06
+ * \date 2013-01-06
  */
 
 
 			 * \param[in] p_resFilename Filename of resource file
 			 * \param[in] p_compress Compression type if the complete file is
 			 *                       compressed
-			 * \param[in[ p_encrypt Encryption type if the complete file is
+			 * \param[in] p_encrypt Encryption type if the complete file is
 			 *                      encrypted
 			 * \param[in] p_key Password if whole file is encrypted
 			 *
 			 *
 			 * \param[out] p_numRes Number of resources in list
 			 *
-			 * \remarks The calles is resposible to free the used memory
+			 * \remarks The caller is resposible to free the used memory
 			 */
 			char **get_resource_ids(int &);
 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.