Skip to content

Commit

Permalink
doc one_critical_filtration
Browse files Browse the repository at this point in the history
  • Loading branch information
hschreiber committed Aug 28, 2024
1 parent 1149065 commit ee521b3
Show file tree
Hide file tree
Showing 4 changed files with 736 additions and 81 deletions.
12 changes: 12 additions & 0 deletions src/Multi_filtration/doc/COPYRIGHT
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
The files of this directory are part of the Gudhi Library - https://gudhi.inria.fr/ - which is released under MIT.
See file LICENSE or go to https://gudhi.inria.fr/licensing/ for full license details.

Author(s): Hannah Schreiber

Copyright (C) 2024 Inria

This gives everyone the freedoms to use openFrameworks in any context:
commercial or non-commercial, public or private, open or closed source.

You should have received a copy of the MIT License along with this program.
If not, see https://opensource.org/licenses/MIT.
36 changes: 36 additions & 0 deletions src/Multi_filtration/doc/Intro_multi_filtration_values.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
/* This file is part of the Gudhi Library - https://gudhi.inria.fr/ - which is released under MIT.
* See file LICENSE or go to https://gudhi.inria.fr/licensing/ for full license details.
* Author(s): Hannah Schreiber
*
* Copyright (C) 2024 Inria
*
* Modification(s):
* - YYYY/MM Author: Description of the modification
*/

#ifndef DOC_MULTI_FILTRATION_INTRO_H_
#define DOC_MULTI_FILTRATION_INTRO_H_

// needs namespace for Doxygen to link on classes
namespace Gudhi {
namespace multi_filtration {

/** \defgroup multi_filtration Multi-parameter Filtration Values
* @{
* \author David Loiseaux
*
* \section multifiltrationintro Multi-parameter Filtration Values
*
* TODO: introduction to @ref One_critical_filtration and @ref Multi_critical_filtration
*
* \subsection multifiltrationexamples Examples
*
* Here is a list of examples using the module:
* \li TODO?.
*
* @}
*/
} // namespace persistence_fields
} // namespace Gudhi

#endif // DOC_MULTI_FILTRATION_INTRO_H_
Loading

0 comments on commit ee521b3

Please sign in to comment.