summaryrefslogtreecommitdiff
path: root/src/common
diff options
context:
space:
mode:
authorvrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2019-02-12 14:08:56 +0000
committervrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2019-02-12 14:08:56 +0000
commitf29a6e9a03dca95dc0a070b604fb11e18897a6f6 (patch)
tree0da92a78fad0b15c119c18480b6d98d94924c78e /src/common
parentb1843507262c7c0d9831ebbeb2f43f43093aa15d (diff)
Fix doc for C++ and Python.
Fix some warnings on Nerve GIC sphinx doc generation git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/cubical_complex_small_fix@4101 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 57eacb8c4108be212e61796c65e3b45bb9c13644
Diffstat (limited to 'src/common')
-rw-r--r--src/common/doc/file_formats.h8
1 files changed, 4 insertions, 4 deletions
diff --git a/src/common/doc/file_formats.h b/src/common/doc/file_formats.h
index d38d90e0..23214e25 100644
--- a/src/common/doc/file_formats.h
+++ b/src/common/doc/file_formats.h
@@ -72,7 +72,7 @@ namespace Gudhi {
\section FileFormatsPerseus Perseus
- This file format is the format used by the Perseus software
+ This file format is a format inspired from the Perseus software
(http://www.sas.upenn.edu/~vnanda/perseus/) by Vidit Nanda.
The first line contains a number d begin the dimension of the
bitmap (2 in the example below). Next d lines are the numbers of top dimensional cubes in each dimensions (3 and 3
@@ -119,9 +119,9 @@ namespace Gudhi {
Other sample files can be found in the `data/bitmap` folder.
- Please note that unlike in Perseus format the filtration on the maximal cubes can be any double precision number.
- Consequently one cannot mark the cubes that are not present with -1's. To do that please set their filtration value to
- +Inf.
+ \note Unlike in Perseus format the filtration on the maximal cubes can be any double precision number.
+ Consequently one cannot mark the cubes that are not present with `-1`'s. To do that please set their filtration value
+ to \f$+\infty\f$ (aka. `inf` in the file).
*/
} // namespace Gudhi