Commits

Andreas Tscharner committed dd80fd0

Updated a few documents and files to get ready for 0.1

  • Participants
  • Parent commits dee68cb
  • Tags 0.1

Comments (0)

Files changed (6)

 
 * .rc file: There have to be at least 2 delimiters (space or tab) between
   the resource id and the resourece file name. Otherwise the filename does
-  not get parsed correctly and the program exists with error code -1002
+  not get parsed correctly and the program exits with error code -1002
 decided to write one myself, based on that idea.
 
 lrc consists of two parts: The compiler itself, a command line tool called
-``lrc`` and a library to extract the resources from the generated Resource Data
-file. The library is called ``liblrc``.
+``lrc`` and a library to extract the resources from the generated Resource
+Data file. The library is called ``liblrc``.
 
 lrc
 ---
 
 Contributions / Patches
 -----------------------
-Contributions in form of patches, tanslations, etc. are welcome. You may
+Contributions in form of corrections, tanslations, etc. are welcome. You may
 send them as patches (if possible git format), or - if you use Mercurial -
 as bundle or I might pull from your repository if it is reachable in the
 Net.
 The source code is hosted on a public repository at BitBucket_. The URL is
 <https://bitbucket.org/StarFire/lrc>.
 
-A final warning remark!
------------------------
-As of today (2011-06-12) many things that are described here are **not**
-**yet** **implemented**!
-
 
 .. [#] It might also cause performance problems if there are many files to load
 
 # This could be handy for archiving the generated documentation or 
 # if some version control system is used.
 
-PROJECT_NUMBER         = pre-0.1
+PROJECT_NUMBER         = 0.1
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description 
 # for a project that appears at the top of each page and should give viewer 

src/compiler/lrc.cxx

  * and then the collector which creates the .rdf file
  *
  * \author Andreas Tscharner
- * \date 2011-07-12
- *
- *
- * \mainpage lrc - Linux Resource Compiler
- *
- * \section into Introduction
- * This documentation covers the classes and data structures of the \c lrc
- * compiler. The documentation of \c liblrc is separate.\n
- * Part of this documentation is the description of the options the \c lrc
- * compiler can be called with.
- *
- * \section options Compiler Options
- * The compiler needs at least one input file. It is called as follows:\n
- * <tt>lrc [-d] [-o <rdfFile>] <RCFile>|<rifFile></tt>\n\n
- * The options have the following meaning:\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>-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.
- *
- * \author Andreas Tscharner
- * \date 2011-07-03
+ * \date 2011-07-23
  */
 
 

src/include/Resource.hxx

 #include "EncryptDecrypt.hxx"
 
 
+/*! \mainpage lrc - Linux Resource Compiler
+ *
+ * \section intro Introduction
+ * This documentation covers the classes and data structures of the \c lrc
+ * compiler and the library \c liblrc.\n
+ *
+ * \section options Compiler Options
+ * The compiler needs at least one input file. It is called as follows:\n
+ * <tt>lrc [-d] [-o <rdfFile>] <RCFile>|<rifFile></tt>\n\n
+ * The options have the following meaning:\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>-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.
+ *
+ * \section liblrc The library liblrc
+ * The library consists mainly of two classes: the \link
+ * lrc::ResourceManager ResourceManager\endlink and the \link lrc::Resource
+ * Resource\endlink class. One ResourceManager instance is used for one
+ * resource data file (.rdf).\n
+ * The resource manager provides only two methods: one lists all resource
+ * entries from the .rdf file, the other returns an instance of a Resource
+ * class, identified by its ID.
+ *
+ * \section example Example
+ * An example that demonstrates the \c lrc and \c liblrc can be found in the
+ * <tt>src\\example</tt> directory.
+ *
+ * \author Andreas Tscharner
+ * \date 2011-07-23
+ */
+
+
 #define MAX_ID_LEN 80                  //!< Maximum length of resource ID
 
 

src/include/ResourceManager.hxx

 #define __RESOURCE_MANAGER_HXX__
 
 
-/*! \mainpage liblrc - The Linux Resource Compiler Library
- *
- *
- * \author Andreas Tscharner
- * \date 2011-07-12
- */
-
-
 // Include files
 #include <stddef.h>
 #include "Resource.hxx"