diff cinst/mozilla.c @ 232:774e944c395b

Cleand up doku.
author Sascha Wilde <wilde@intevation.de>
date Fri, 28 Mar 2014 10:50:14 +0100
parents c342b93c5bd1
children 0c4d65a7cd14
line wrap: on
line diff
--- a/cinst/mozilla.c	Fri Mar 28 10:45:55 2014 +0100
+++ b/cinst/mozilla.c	Fri Mar 28 10:50:14 2014 +0100
@@ -31,23 +31,6 @@
  *
  */
 
-/* @brief IniParser for mozilla profiles.ini
- *
- * Parse data to find values formed in
- *
- * [Profile99]
- * IsRelative=1
- * Path=Profiles/fooo.bar
- *
- * or
- * [Profile0]
- * IsRelative=0
- * Path=c:\foo\bar\baz
- *
- * Mozilla also accepts the ini file on Windows even if it is UTF-16
- * encoded.
- * */
-
 #include <dirent.h>
 #include <cert.h>
 #include <certt.h>
@@ -122,7 +105,21 @@
 /**
  * @brief Get a list of all mozilla profile directories
  *
- * Read the profiles.ini and extract all profile paths from that.
+ * Parse the profiles.ini and extract all profile paths from that.
+ * The expected data is in the form:
+ *
+ * [Profile99]
+ * IsRelative=1
+ * Path=Example/fooo.bar
+ *
+ * or
+ * [Profile0]
+ * IsRelative=0
+ * Path=c:\foo\bar\baz
+ *
+ * Mozilla also accepts the ini file on Windows even if it is UTF-16
+ * encoded but never writes UTF-16 on its own.  So currently we ignore
+ * this special case.
  *
  * @param[in] inifile_name path of the profile.ini to read.
  * @return NULL terminated array of strings containing containing the

http://wald.intevation.org/projects/trustbridge/