Skip to content

Commit

Permalink
Revision of the doxygen documentation main pages
Browse files Browse the repository at this point in the history
  • Loading branch information
@nils-hamel
nils-hamel committed Nov 9, 2018
1 parent 9b0d004 commit 173ff14
Show file tree
Hide file tree
Showing 5 changed files with 191 additions and 193 deletions.
77 changes: 38 additions & 39 deletions lib/libcommon/src/common.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,62 +30,62 @@
*
* The _eratosthene-suite_ offers a front-end to the eratosthene indexation
* server implemented in the _liberatosthene_ library. It consists in a
* softwares suite offering front-end solutions to the functionalities of
* software suite offering front-end solutions to the functionalities of
* the eratosthene library.
*
* The principal software implements the server itself allowing to simply
* create server instances and to maintain services. The suite also offers
* a front-end software for the data injection in the available servers. It
* also offers a graphical 4D solution allowing to browse the 4D earth
* model offered by the available servers.
*
* In addition to the server, client data injection and the 4D graphical
* client softwares, the suite also provides a tools allowing to massively
* query 4D earth cells, following the _liberatosthene_ indexation
* formalism, to build large 3D-raster datasets. Such datasets can be used
* to train and validate machine learning algorithms working on 3D/4D
* geographic information.
* The principal software implements the server itself, allowing to simply
* create server instances and to maintain network services. The suite also
* offers a front-end software for the data injection in server instances.
* It also offers a graphical 4D solution allowing to browse the 4D model
* of Earth offered by servers.
*
* \section project Eratosthene Project
*
* The Eratosthene Project was initially imagined to answer the question of
* very large point-based models of cities and environments. Indeed,
* mapping a whole city at the level of the centimetre induces very large
* The Eratosthene Project was initially designed to address the challenge
* of very large point-based models of cities and environments. Indeed,
* mapping a whole city at the level of the centimeter induces very large
* and heavy models that are difficult to manipulate, explore and exploit.
* Moreover, considering the time dimension implies a quick increase of the
* size of the models, making them impossible to handle as a single and
* monolithic object.
*
* The Eratosthene Project is designed to answer this question by
* implementing an space-time indexation formalism able to handle, store
* and access very large 4D models of cities and environments. The
* indexation formalism is used to implement a server able to manage, store
* and broadcast very large 4D models distributed all over the earth
* surface and covering large period of time. In addition to the server,
* the Eratosthene Project also implements a graphical client able to
* communicate with the server and to offer a convenient way of browsing
* the models in both space and time.
* The Eratosthene Project is designed to provide a solution by considering
* a space-time indexation formalism. This indexation formalism is used to
* implement a server able to manage, store and broadcast over the network
* very large 4D models distributed all over the earth surface and covering
* large periods of time. In addition to the server, the Eratosthene
* Project also implements a graphical client able to communicate with the
* remote servers to offer a convenient way to browse the models in both
* space and time.
*
* The space-time indexation formalism is designed to efficiently manage
* the storage of the incoming 4D models and to offer and simple and
* efficient ways of addressing queries to the server allowing models
* the storage of the incoming 4D models and to offer a simple and
* efficient way of addressing queries to the server to allow models
* broadcasting. The space-time indexation also allows to perform queries
* to the server in a intuitive way giving the possibility to both address
* the questions of the earth structures level of detail and time
* to the server in an intuitive way giving the possibility to both address
* the challenge of the earth structures level of details and time
* management. This allows to explore the entire earth surface in terms of
* 4D structures from large mountain chains in 2000 to very small details
* of cities in 1850.
*
* The subsequent indexation formalism used to drive the storage and access
* of the data also naturally brings a standardised discretisation of space
* and time. Models injected in the information system are then
* standardised from both spatial and temporal point of view. This allows
* the implementation of binary and logical operators when considering a
* model at two different times. The operators allows to deduce a third
* model providing a differential point of view of the two models separated
* in time. The evolution of cities and environments can be enhanced and
* analysed in an efficient way, opening the way to more advanced
* geographic services.
* and time. Point-based models injected in the Eratosthene information
* system are then standardised from both spatial and temporal point of
* views. This allows the implementation of binary and logical operators
* when considering a model at two different times. The operators allow to
* deduce a third model on the fly providing a differential point of view
* of the two models separated in time. The evolution of cities and
* environments can be enhanced and analysed in an efficient way, opening
* the way to more advanced geographic services.
*
* The ability of indexation formalism to consider polygonal models in
* addition to large scale point-based models allows to enhance the
* possibilities in terms of 4D geographic services. More than the
* possibility to automatically manage the polygonal models level of
* details and large scale display, the indexation formalism also allows
* compositions on the fly of mixed models allowing to compare different
* type of models, from lidar point-based models to land registers.
*
* \section license Copyright and License
*
Expand All @@ -94,7 +94,6 @@
*
* This program is licensed under the terms of the GNU GPLv3.
*/

/*
header - inclusion guard
*/
Expand Down
77 changes: 38 additions & 39 deletions src/eratosthene-address/src/eratosthene-address.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,62 +30,62 @@
*
* The _eratosthene-suite_ offers a front-end to the eratosthene indexation
* server implemented in the _liberatosthene_ library. It consists in a
* softwares suite offering front-end solutions to the functionalities of
* software suite offering front-end solutions to the functionalities of
* the eratosthene library.
*
* The principal software implements the server itself allowing to simply
* create server instances and to maintain services. The suite also offers
* a front-end software for the data injection in the available servers. It
* also offers a graphical 4D solution allowing to browse the 4D earth
* model offered by the available servers.
*
* In addition to the server, client data injection and the 4D graphical
* client softwares, the suite also provides a tools allowing to massively
* query 4D earth cells, following the _liberatosthene_ indexation
* formalism, to build large 3D-raster datasets. Such datasets can be used
* to train and validate machine learning algorithms working on 3D/4D
* geographic information.
* The principal software implements the server itself, allowing to simply
* create server instances and to maintain network services. The suite also
* offers a front-end software for the data injection in server instances.
* It also offers a graphical 4D solution allowing to browse the 4D model
* of Earth offered by servers.
*
* \section project Eratosthene Project
*
* The Eratosthene Project was initially imagined to answer the question of
* very large point-based models of cities and environments. Indeed,
* mapping a whole city at the level of the centimetre induces very large
* The Eratosthene Project was initially designed to address the challenge
* of very large point-based models of cities and environments. Indeed,
* mapping a whole city at the level of the centimeter induces very large
* and heavy models that are difficult to manipulate, explore and exploit.
* Moreover, considering the time dimension implies a quick increase of the
* size of the models, making them impossible to handle as a single and
* monolithic object.
*
* The Eratosthene Project is designed to answer this question by
* implementing an space-time indexation formalism able to handle, store
* and access very large 4D models of cities and environments. The
* indexation formalism is used to implement a server able to manage, store
* and broadcast very large 4D models distributed all over the earth
* surface and covering large period of time. In addition to the server,
* the Eratosthene Project also implements a graphical client able to
* communicate with the server and to offer a convenient way of browsing
* the models in both space and time.
* The Eratosthene Project is designed to provide a solution by considering
* a space-time indexation formalism. This indexation formalism is used to
* implement a server able to manage, store and broadcast over the network
* very large 4D models distributed all over the earth surface and covering
* large periods of time. In addition to the server, the Eratosthene
* Project also implements a graphical client able to communicate with the
* remote servers to offer a convenient way to browse the models in both
* space and time.
*
* The space-time indexation formalism is designed to efficiently manage
* the storage of the incoming 4D models and to offer and simple and
* efficient ways of addressing queries to the server allowing models
* the storage of the incoming 4D models and to offer a simple and
* efficient way of addressing queries to the server to allow models
* broadcasting. The space-time indexation also allows to perform queries
* to the server in a intuitive way giving the possibility to both address
* the questions of the earth structures level of detail and time
* to the server in an intuitive way giving the possibility to both address
* the challenge of the earth structures level of details and time
* management. This allows to explore the entire earth surface in terms of
* 4D structures from large mountain chains in 2000 to very small details
* of cities in 1850.
*
* The subsequent indexation formalism used to drive the storage and access
* of the data also naturally brings a standardised discretisation of space
* and time. Models injected in the information system are then
* standardised from both spatial and temporal point of view. This allows
* the implementation of binary and logical operators when considering a
* model at two different times. The operators allows to deduce a third
* model providing a differential point of view of the two models separated
* in time. The evolution of cities and environments can be enhanced and
* analysed in an efficient way, opening the way to more advanced
* geographic services.
* and time. Point-based models injected in the Eratosthene information
* system are then standardised from both spatial and temporal point of
* views. This allows the implementation of binary and logical operators
* when considering a model at two different times. The operators allow to
* deduce a third model on the fly providing a differential point of view
* of the two models separated in time. The evolution of cities and
* environments can be enhanced and analysed in an efficient way, opening
* the way to more advanced geographic services.
*
* The ability of indexation formalism to consider polygonal models in
* addition to large scale point-based models allows to enhance the
* possibilities in terms of 4D geographic services. More than the
* possibility to automatically manage the polygonal models level of
* details and large scale display, the indexation formalism also allows
* compositions on the fly of mixed models allowing to compare different
* type of models, from lidar point-based models to land registers.
*
* \section license Copyright and License
*
Expand All @@ -95,7 +95,6 @@
* This program is licensed under the terms of the GNU GPLv3.
*/


/*
header - inclusion guard
*/
Expand Down
78 changes: 39 additions & 39 deletions src/eratosthene-client/src/eratosthene-client.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,62 +30,62 @@
*
* The _eratosthene-suite_ offers a front-end to the eratosthene indexation
* server implemented in the _liberatosthene_ library. It consists in a
* softwares suite offering front-end solutions to the functionalities of
* software suite offering front-end solutions to the functionalities of
* the eratosthene library.
*
* The principal software implements the server itself allowing to simply
* create server instances and to maintain services. The suite also offers
* a front-end software for the data injection in the available servers. It
* also offers a graphical 4D solution allowing to browse the 4D Earth
* model offered by the available servers.
*
* In addition to the server, client data injection and the 4D graphical
* client softwares, the suite also provides a tools allowing to massively
* query 4D Earth cells, following the _liberatosthene_ indexation
* formalism, to build large 3D-raster datasets. Such datasets can be used
* to train and validate machine learning algorithms working on 3D/4D
* geographic information.
* The principal software implements the server itself, allowing to simply
* create server instances and to maintain network services. The suite also
* offers a front-end software for the data injection in server instances.
* It also offers a graphical 4D solution allowing to browse the 4D model
* of Earth offered by servers.
*
* \section project Eratosthene Project
*
* The Eratosthene Project was initially imagined to answer the question of
* very large point-based models of cities and environments. Indeed,
* mapping a whole city at the level of the centimetre induces very large
* The Eratosthene Project was initially designed to address the challenge
* of very large point-based models of cities and environments. Indeed,
* mapping a whole city at the level of the centimeter induces very large
* and heavy models that are difficult to manipulate, explore and exploit.
* Moreover, considering the time dimension implies a quick increase of the
* size of the models, making them impossible to handle as a single and
* monolithic object.
*
* The Eratosthene Project is designed to answer this question by
* implementing an space-time indexation formalism able to handle, store
* and access very large 4D models of cities and environments. The
* indexation formalism is used to implement a server able to manage, store
* and broadcast very large 4D models distributed all over the Earth
* surface and covering large period of time. In addition to the server,
* the Eratosthene Project also implements a graphical client able to
* communicate with the server and to offer a convenient way of browsing
* the models in both space and time.
* The Eratosthene Project is designed to provide a solution by considering
* a space-time indexation formalism. This indexation formalism is used to
* implement a server able to manage, store and broadcast over the network
* very large 4D models distributed all over the earth surface and covering
* large periods of time. In addition to the server, the Eratosthene
* Project also implements a graphical client able to communicate with the
* remote servers to offer a convenient way to browse the models in both
* space and time.
*
* The space-time indexation formalism is designed to efficiently manage
* the storage of the incoming 4D models and to offer and simple and
* efficient ways of addressing queries to the server allowing models
* the storage of the incoming 4D models and to offer a simple and
* efficient way of addressing queries to the server to allow models
* broadcasting. The space-time indexation also allows to perform queries
* to the server in a intuitive way giving the possibility to both address
* the questions of the Earth structures level of detail and time
* management. This allows to explore the entire Earth surface in terms of
* to the server in an intuitive way giving the possibility to both address
* the challenge of the earth structures level of details and time
* management. This allows to explore the entire earth surface in terms of
* 4D structures from large mountain chains in 2000 to very small details
* of cities in 1850.
*
* The subsequent indexation formalism used to drive the storage and access
* of the data also naturally brings a standardised discretisation of space
* and time. Models injected in the information system are then
* standardised from both spatial and temporal point of view. This allows
* the implementation of binary and logical operators when considering a
* model at two different times. The operators allows to deduce a third
* model providing a differential point of view of the two models separated
* in time. The evolution of cities and environments can be enhanced and
* analysed in an efficient way, opening the way to more advanced
* geographic services.
* and time. Point-based models injected in the Eratosthene information
* system are then standardised from both spatial and temporal point of
* views. This allows the implementation of binary and logical operators
* when considering a model at two different times. The operators allow to
* deduce a third model on the fly providing a differential point of view
* of the two models separated in time. The evolution of cities and
* environments can be enhanced and analysed in an efficient way, opening
* the way to more advanced geographic services.
*
* The ability of indexation formalism to consider polygonal models in
* addition to large scale point-based models allows to enhance the
* possibilities in terms of 4D geographic services. More than the
* possibility to automatically manage the polygonal models level of
* details and large scale display, the indexation formalism also allows
* compositions on the fly of mixed models allowing to compare different
* type of models, from lidar point-based models to land registers.
*
* \section license Copyright and License
*
Expand Down
Loading

0 comments on commit 173ff14

Please sign in to comment.