comments explaining the funtion

release/4.3a0
balderdash-devil 2014-05-31 16:13:29 -04:00
parent 34962d4669
commit cd1b503985
2 changed files with 4 additions and 2 deletions

View File

@ -68,6 +68,7 @@ string findExampleDataFile(const string& name) {
name + ", " + name + ".graph, or " + name + ".txt");
}
/* ************************************************************************* */
string createRewrittenFileName(const string& name) {
// Search source tree and installed location
if(!exists(fs::path(name))) {
@ -81,6 +82,7 @@ string createRewrittenFileName(const string& name) {
return newpath.string();
}
/* ************************************************************************* */
#endif
/* ************************************************************************* */

View File

@ -46,8 +46,8 @@ namespace gtsam {
GTSAM_EXPORT std::string findExampleDataFile(const std::string& name);
/**
* searches for the file using the findExample funtion, if not found ,
* creates one in the source tree and returns the full path
* Creates a temporary file name that needs to be ignored in .gitingnore
* for checking read-write oprations
*/
GTSAM_EXPORT std::string createRewrittenFileName(const std::string& name);
#endif