Skip to content

Commit

Permalink
Define User Manual sections
Browse files Browse the repository at this point in the history
  • Loading branch information
JacksonCampolattaro committed Jul 16, 2020
1 parent 2557dab commit 579ee15
Showing 1 changed file with 7 additions and 14 deletions.
21 changes: 7 additions & 14 deletions Octree/doc/Octree/Octree.txt
@@ -1,27 +1,20 @@
namespace CGAL {

/*!
\mainpage Octree
\mainpage User Manual
\anchor Chapter_Octree

\cgalAutoToc
\author Jackson Campolattaro

Introductory text.
\section Section_Octree_Introduction Introduction

\section Section_Octree_Definitions Definitions
Introduction section.

Definitions section.

\subsection Subsection_Octree_Basic_Description Description

Description of the octree

Maybe more subsections with examples

...

\section Section_Octree_Design Design
\section Section_Octree_Splitting_Rules Splitting Rules
\section Section_Octree_Walker_Rules Walker Rules
\section Section_Octree_Example_Programs Example Programs
\section Section_Octree_Software_Design Software Design

Explain the design of the package.

Expand Down

0 comments on commit 579ee15

Please sign in to comment.