From 93c97a9a93b930a2f3c1c119d9e4d2567c54dacc Mon Sep 17 00:00:00 2001
From: cjamin <cjamin@636b058d-ea47-450e-bf9e-a15bfbe3eedb>
Date: Fri, 9 Jun 2017 11:20:13 +0000
Subject: Create a new page for file formats

git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/read_persistence_from_file@2534 636b058d-ea47-450e-bf9e-a15bfbe3eedb

Former-commit-id: dc0d836b9df68a3f339dcbc6b8ff51577faf3d7b
---
 src/common/doc/file_formats.h | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 src/common/doc/file_formats.h

(limited to 'src/common/doc/file_formats.h')

diff --git a/src/common/doc/file_formats.h b/src/common/doc/file_formats.h
new file mode 100644
index 00000000..1f7ba201
--- /dev/null
+++ b/src/common/doc/file_formats.h
@@ -0,0 +1,25 @@
+/*! \page fileformats File formats
+ 
+ \tableofcontents
+
+ \section FileFormatsPers Persistence Diagram
+
+ Such a file, whose extension is usually `.pers`, contains a list of persistence intervals.<br>
+ Lines starting with `#` are ignored (comments).<br>
+ Other lines might contain 2, 3 or 4 values (the number of values on each line must be the same for all lines):
+ \code{.unparsed}
+   [[field] dimension] birth death
+ \endcode
+
+ Here is a simple sample file:
+ \code{.unparsed}
+   # Beautiful persistence diagram
+   2 2.7 3.7
+   2 9.6 14.
+   3 34.2 34.974
+   4 3. inf
+ \endcode
+
+ Other sample files can be found in the `data/persistence_diagram` folder.
+ 
+*/
\ No newline at end of file
-- 
cgit v1.2.3


From 8b8689e9dc0c9970eee7c75cb8ea08433ce28196 Mon Sep 17 00:00:00 2001
From: cjamin <cjamin@636b058d-ea47-450e-bf9e-a15bfbe3eedb>
Date: Tue, 13 Jun 2017 13:37:48 +0000
Subject: Add header and namespace + remove unnecessary include

git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/read_persistence_from_file@2537 636b058d-ea47-450e-bf9e-a15bfbe3eedb

Former-commit-id: fc2da43c18649c606ac4760a923684f9eef0c95e
---
 src/common/doc/file_formats.h | 33 +++++++++++++++++++++++++++++++--
 src/common/doc/main_page.h    |  3 +--
 2 files changed, 32 insertions(+), 4 deletions(-)

(limited to 'src/common/doc/file_formats.h')

diff --git a/src/common/doc/file_formats.h b/src/common/doc/file_formats.h
index 1f7ba201..c145b271 100644
--- a/src/common/doc/file_formats.h
+++ b/src/common/doc/file_formats.h
@@ -1,3 +1,30 @@
+/*    This file is part of the Gudhi Library. The Gudhi library
+*    (Geometric Understanding in Higher Dimensions) is a generic C++
+*    library for computational topology.
+*
+*    Author(s):       Clément Jamin
+*
+*    Copyright (C) 2017  INRIA
+*
+*    This program is free software: you can redistribute it and/or modify
+*    it under the terms of the GNU General Public License as published by
+*    the Free Software Foundation, either version 3 of the License, or
+*    (at your option) any later version.
+*
+*    This program is distributed in the hope that it will be useful,
+*    but WITHOUT ANY WARRANTY; without even the implied warranty of
+*    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+*    GNU General Public License for more details.
+*
+*    You should have received a copy of the GNU General Public License
+*    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#ifndef DOC_COMMON_FILE_FORMAT_H_
+#define DOC_COMMON_FILE_FORMAT_H_
+
+namespace Gudhi {
+
 /*! \page fileformats File formats
  
  \tableofcontents
@@ -21,5 +48,7 @@
  \endcode
 
  Other sample files can be found in the `data/persistence_diagram` folder.
- 
-*/
\ No newline at end of file
+*/
+}  // namespace Gudhi
+
+#endif  // DOC_COMMON_FILE_FORMAT_H_
diff --git a/src/common/doc/main_page.h b/src/common/doc/main_page.h
index b7f93ed2..12012ecb 100644
--- a/src/common/doc/main_page.h
+++ b/src/common/doc/main_page.h
@@ -468,5 +468,4 @@ make doxygen
  * @example Witness_complex/example_witness_complex_persistence.cpp
  * @example Witness_complex/example_witness_complex_sphere.cpp
  */
-
-#include "file_formats.h"
\ No newline at end of file
+ 
\ No newline at end of file
-- 
cgit v1.2.3