From 73769059284b48ef333d82be5d12a9311fe49e40 Mon Sep 17 00:00:00 2001 From: Christian Zimmermann Date: Sat, 30 Dec 2023 00:09:29 +0100 Subject: [PATCH] doxy: use readme as main page --- README.md | 12 ++++++++---- doc/doxy/Doxyfile | 4 ++-- src/include/cnorxz.h | 13 ------------- 3 files changed, 10 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 1fe520d..5b86dd8 100644 --- a/README.md +++ b/README.md @@ -9,9 +9,10 @@ This library provides a framework for handling multi dimensional containers, the The library can be installed by the following procedure (`gtest` required): ```bash -git clone git@git.f3l.de:chizeta/cnorxz.git +git clone git@git.f3l.de:chizeta/cnorxz.git +mkdir cd -cmake -DCMAKE_INSTALL_PREFIX:PATH= +cmake -DCMAKE_INSTALL_PREFIX:PATH= make install ``` @@ -31,7 +32,7 @@ The tools of the library are accessible within the namespace `CNORXZ`. (Also consider doxygen) -### Basics +### Basics and Library organization This library consists of several building blocks. For simple usage, the most important building blocks are [ranges](#ranges), [indices](#indices) and [array types](#arrays). @@ -63,8 +64,11 @@ Apart from range specific indices, there exist also special indices: * `BIndex` : The same as `AIndex`, but not const. -#### Arrays +#### Array types Finally, there are the container classes (arrays), which are derived from `CArrayBase` (const) or `ArrayBase` for a given data type `T`. All arrays are defined on a range, their data can be accessed or iterated over using suitable indices. The array-type actually containing data is called `MArray`. Moreover, there exist array-types that do not contain data, but view the data of other arrays or at least parts of the data. These are called `CSlice` (const view) or `Slice`. +#### Expressions and Operations + +... diff --git a/doc/doxy/Doxyfile b/doc/doxy/Doxyfile index d642b5f..d54e1f3 100644 --- a/doc/doxy/Doxyfile +++ b/doc/doxy/Doxyfile @@ -943,7 +943,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = ../../src +INPUT = ../../README.md ../../src # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses @@ -1110,7 +1110,7 @@ FILTER_SOURCE_PATTERNS = # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. -USE_MDFILE_AS_MAINPAGE = +USE_MDFILE_AS_MAINPAGE = README.md # The Fortran standard specifies that for fixed formatted Fortran code all # characters from position 72 are to be considered as comment. A common diff --git a/src/include/cnorxz.h b/src/include/cnorxz.h index c67f97a..21a1b01 100644 --- a/src/include/cnorxz.h +++ b/src/include/cnorxz.h @@ -9,19 +9,6 @@ **/ -/** - @mainpage CNORXZ Documentation - - ## Library organization - - ## Ranges and Indices - - ## Array types - - ## Expressions and Operations - - **/ - #ifndef __cxz_cnorxz_h__ #define __cxz_cnorxz_h__