Anonymous avatar Anonymous committed 7d9ff99

More improvements to the documentation entry points

Comments (0)

Files changed (3)

 The AOTUS library provides a Fortran wrapper around the C-API of the
 [Lua](http://www.lua.org) scripting language, allowing a convenient usage of Lua
 scripts as configuration files in Fortran applications.
-Please have look at the [Wiki](https://bitbucket.org/haraldkl/aotus/wiki/Home)
+Please have a look at the [Wiki](https://bitbucket.org/haraldkl/aotus/wiki/Home)
 for more information on its usage.
+And for a detailed interface reference visit its
+[Doxygen generated documentation](https://geb.sts.nt.uni-siegen.de/aotus)
 
-This library is released under a simplified MIT licence, please have look at the
-COPYRIGHT file for details.
+*This library is released under a simplified MIT licence, please have a look into the COPYRIGHT file for details.*
 
 How To Build
 ------------
 
 This will build a html directory in the build directory with the resulting
 documentation. Note, that this requires an installed doxygen.
-It is also online available as
+It is also online available at
 [Aotus documentation](https://geb.sts.nt.uni-siegen.de/aotus).
 
 ### Example
 The AOTUS library provides a Fortran wrapper around the C-API of the
 [Lua](http://www.lua.org) scripting language, allowing a convenient usage of Lua
 scripts as configuration files in Fortran applications.
-Please have look at the [Wiki](https://bitbucket.org/haraldkl/aotus/wiki/Home)
-for more information on its usage.
 
-This library is released under a simplified MIT licence, please have look at the
-COPYRIGHT file for details.
+**It is available for download on [Bitbucket](https://bitbucket.org/haraldkl/aotus).**
+
+Please visit the [Wiki](https://bitbucket.org/haraldkl/aotus/wiki/Home)
+for further information on its usage.
+
+*This library is released under a simplified MIT licence, please have a look into the COPYRIGHT file for details.*
 
 How To Build
 ------------
 
 This will build a html directory in the build directory with the resulting
 documentation. Note, that this requires an installed doxygen.
-It is also online available as
+It is also online available at
 [Aotus documentation](https://geb.sts.nt.uni-siegen.de/aotus).
 
 ### Example
 It can be used with the provided *config.lua* in the *sample* directory, where
 also the source of this small program is found.
 
+Getting Started
+---------------
+The central module in this library is the [aotus_module](@ref aotus_module),
+its documentation and the [Aotus overview](@ref aot_overview) would be good
+starting points.
+
 Related Projects
 ----------------
 
 
 * [f2k3-lua](https://github.com/MaikBeckmann/f2k3-lua/tree/simple)
 * [FortLua](https://github.com/adolgert/FortLua)
+
+
+License
+=======
+
+Aotus is licensed under the terms of the MIT license reproduced below.
+This means that Aotus is free software and can be used for both academic and
+commercial purposes at absolutely no cost. You are free to do with the code
+whatever you want.
+The only requirement is that some credit to the authors is given by putting this
+copyright notice somewhere in your project.
+The MIT license is chosen for full compatibility with Lua.
+
+For the license of the underlying Lua library have a look at
+http://www.lua.org/license.html.
+
+---
+Copyright (C) 2011-2013 German Research School for Simulation Sciences GmbH, Aachen.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+---

source/aotus_module.f90

 !! Its central interface is aot_get_val, which is a generic interface that
 !! allows access to scalars and vectors in global Lua variables as well as
 !! nested tables.
+!!
+!! In the \ref aot_overview "overview page" there are some more general
+!! remarks and further pointers.
 module aotus_module
   use flu_binding
   use aot_kinds_module, only: double_k, single_k, long_k
 
 end module aotus_module
 
-!> \page Aotus
+!> \page aot_overview Overview for Aotus
 !!
 !! Aotus stands for *Advanced Options in Tables and Universal Scripting*.
 !!
 !!
 !! Aotus provides several layers, encapsulating the bare
 !! [Lua C-API](http://www.lua.org/manual/5.2/manual.html#4):
-!! - Lua_fif: this just provides the
+!! - \ref lua_fif this just provides the
 !!   [ISO_C_Binding](http://www.fortran.bcs.org/2002/interop.htm)
 !!   interface declarations.
-!! - Flu_binding: this the actural Fortran binding wrapped around Lua_fif, to
-!!   provide a more Fortran like interface.
-!!   Especially the Flu_binding::flu_state type is declared which maintains the
+!! - \ref flu_binding this the actural Fortran binding wrapped around lua_fif,
+!!   to provide a more Fortran like interface.
+!!   Especially the flu_binding::flu_state type is declared which maintains the
 !!   handle for the
 !!   [Lua state](http://www.lua.org/manual/5.2/manual.html#lua_state).
-!! - AOT_table_module: provides some convenience functions to work on Lua tables
-!!   in Fortran.
-!! - AOT_fun_module: provides some convenience functions to work with Lua
+!! - \ref aot_table_module provides some convenience functions to work on Lua
+!!   tables in Fortran.
+!! - \ref aot_fun_module provides some convenience functions to work with Lua
 !!   functions in Fortran.
-!! - Aotus_module: provides the high end level to easily retrieve data from a
-!!   Lua script.
-!! - On top of those there is an additional AOT_vector_module, which allows the
-!!   concise reading of values into arrays of rank one.
-!! - Finally there is and additional AOT_out_module, that allows output of
+!! - \ref aotus_module provides the high end level to easily retrieve data from
+!!   a Lua script.
+!! - On top of those there is an additional \ref aot_vector_module, which allows
+!!   the concise reading of values into arrays of rank one.
+!! - Finally there is and additional \ref aot_out_module, that allows output of
 !!   Fortran values into nested Lua tables.
 !!
 !! The library can be compiled by various modern Fortran compilers as described
 !! in sample/aotus_sample.f90 in the Aotus main directory.
 !! The corresponding Lua script used as input is given in sample/config.lua.
 !!
-!! *Please see also the README.rst.*
-!!
-!! *Sources are available at <https://bitbucket.org/haraldkl/aotus/overview>.*
+!! *Sources are available at <https://bitbucket.org/haraldkl/aotus>.*
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.