C++ style to avoid compiler warning for non-NLS implementation of Messages::available

[lyx.git] / src / support / environment.h

diff --git a/src/support/environment.h b/src/support/environment.h
index 6893762f90840fb1a6cf10f995529162e371f44f..296ebc15fbd09d7dfb3416a7755296d4bc9ab51f 100644 (file)
--- a/src/support/environment.h
+++ b/src/support/environment.h
@@ -18,25 +18,27 @@
 namespace lyx {
 namespace support {
 
-/// @returns the contents of the environment variable @c name.
+/// @returns the contents of the environment variable @c name encoded in utf8.
 std::string const getEnv(std::string const & envname);
 
 /** @returns the contents of the environment variable @c name,
- *  split into path elements using the OS-dependent separator token.
+ *  split into path elements using the OS-dependent separator token
+ *  and encoded in utf8.
  *  Each element is then passed through os::internal_path() to
  *  guarantee that it is in the form of a unix-style path.
  *  If the environment variable is not set, then the function returns
  *  an empty vector.
- */
+ */
 std::vector<std::string> const getEnvPath(std::string const & name);
 
 /** Set the contents of the environment variable @c name to @c value.
+ *  \p value is encoded in utf8.
  *  @returns true if the variable was set successfully.
  */
 bool setEnv(std::string const & name, std::string const & value);
 
 /** Set the contents of the environment variable @c name
- *  using the paths stored in the @c env vector.
+ *  using the paths stored in the @c env vector (encoded in utf8).
  *  Each element is passed through os::external_path().
  *  Multiple elements are concatenated into a single string using
  *  os::path_separator().
@@ -45,8 +47,8 @@ void setEnvPath(std::string const & name, std::vector<std::string> const & env);
 
 /** Prepend a list of paths to that returned by the environment variable.
  *  Identical paths occurring later in the list are removed.
- *  @param name the name of the environment variable.
- *  @prefix the list of paths in OS-native syntax.
+ *  @param name the name of the environment variable (encoded in utf8).
+ *  @prefix the list of paths in OS-native syntax (encoded in utf8).
  *  Eg "/foo/bar:/usr/bin:/usr/local/bin" on *nix,
  *     "C:\foo\bar;C:\windows" on Windows.
  */