1. Harald Klimach
  2. aotus

Source

aotus / source / aotus_module.f90

Diff from to

File source/aotus_module.f90

  • Ignore whitespace
 !! 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>.*