summaryrefslogtreecommitdiff
path: root/src/filename_absolute.cxx
diff options
context:
space:
mode:
authorFabien Costantini <fabien@onepost.net>2009-01-20 11:10:29 +0000
committerFabien Costantini <fabien@onepost.net>2009-01-20 11:10:29 +0000
commitb00d2bfa421b1f93bad5bb44899510d933fea36a (patch)
tree425f1a37700d564c40e60b7c7a94281e742e88fa /src/filename_absolute.cxx
parent8d590e0ed8bc1f4b4d7886cca0701fcce2e1fe4d (diff)
Doxygen documentation
+ Added a new Module section named : File names and URI utility funtions + updated the pdf file adequately git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6641 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'src/filename_absolute.cxx')
-rw-r--r--src/filename_absolute.cxx16
1 files changed, 13 insertions, 3 deletions
diff --git a/src/filename_absolute.cxx b/src/filename_absolute.cxx
index db12e5dba..0b40c9310 100644
--- a/src/filename_absolute.cxx
+++ b/src/filename_absolute.cxx
@@ -54,6 +54,13 @@ inline int isdirsep(char c) {return c=='/' || c=='\\';}
#define isdirsep(c) ((c)=='/')
#endif
+/**
+ * Makes a filename absolute from a relative filename.
+ * \param[out] to resulting absolute filename
+ * \param[in] tolen size of the absolute filename buffer
+ * \param[in] from relative filename
+ * \return 0 if no change, non zero otherwise
+ */
int fl_filename_absolute(char *to, int tolen, const char *from) {
if (isdirsep(*from) || *from == '|'
#if defined(WIN32) || defined(__EMX__) && !defined(__CYGWIN__)
@@ -107,10 +114,13 @@ int fl_filename_absolute(char *to, int tolen, const char *from) {
return 1;
}
-/*
- * 'fl_filename_relative()' - Make a filename relative to the current working directory.
+/**
+ * Makes a filename relative to the current working directory.
+ * \param[out] to resulting relative filename
+ * \param[in] tolen size of the relative filename buffer
+ * \param[in] from absolute filename
+ * \return 0 if no change, non zero otherwise
*/
-
int // O - 0 if no change, 1 if changed
fl_filename_relative(char *to, // O - Relative filename
int tolen, // I - Size of "to" buffer