Harald Klimach avatar Harald Klimach committed bfb6daf

Some more formatting

Comments (0)

Files changed (3)

source/aot_fun_module.f90

 !> A module providing access to Lua functions
+!!
 !! Intended usage:
 !! First open a function with aot_fun_open
 !! Then put required parameters inot it with
   end type
 
   !> Open a Lua function for evaluation.
+  !!
   !! After it is opened, arguments might be
   !! put into the function, and it might be
   !! executed. This might be repeated for
   end interface aot_fun_open
 
   !> Put an argument into the lua function.
+  !!
   !! Arguments have to be in order, first put
   !! the first argument then the second and so on.
   interface aot_fun_put
 contains
 
   !> Return the stack of the top as a function.
+  !!
   !! If it actually is not a Lua function, its handle
   !! will be set to 0.
   function aot_fun_top(L) result(fun)

source/aot_out_module.f90

 
   !> Helper function to provide new unit, as long as F2008 newunit argument
   !! in open statement is not commonly available.
+  !!
   !! To be used right in front of the open statement like this:
   !!  myUnit = newunit()
   !!  open(myUnit, ...)

source/aot_table_module.f90

 contains
 
   !> Return the position at the top of the stack as a
-  !! table handle for further operations on that table,
-  !! if it actually exists and is a table. Otherwise
-  !! 0 will be returned.
+  !! table handle.
+  !!
+  !! If it actually exists and is a table, this handle can be used
+  !! for further operations on that table.
+  !! Otherwise a 0 will be returned.
   function aot_table_top(L) result(thandle)
     type(flu_state) :: L
     integer :: thandle
     end if
   end function aot_table_top
 
-  !> Load a globally defined table into the top of the stack
-  !! and return its position in the stack as a handle for this
+
+  !> Load a globally defined table into the top of the stack.
+  !!
+  !! Return its position in the stack as a handle for this
   !! table. If it does not exist or the global variable is not
   !! a table, the handle will be set to 0.
   subroutine aot_table_global(L, thandle, key)
     thandle = aot_table_top(L)
   end subroutine aot_table_global
 
+
   !> This subroutine tries to get a table in a table, and
   !! return a handle for it.
   subroutine aot_table_table(L, parent, thandle, key, pos)
     thandle = aot_table_top(L)
   end subroutine aot_table_table
 
-  !> Close a table again, by popping all values above and itself
-  !! from the stack.
+
+  !> Close a table again.
+  !!
+  !! This is done by popping all values above and itself from the stack.
   subroutine aot_table_close(L, thandle)
     type(flu_state) :: L
     integer, intent(in) :: thandle
     if (thandle > 0) call flu_settop(L, thandle-1)
   end subroutine aot_table_close
 
+
   !> This subroutine tries to push the value of table thandle on
   !! the lua stack, or if this fails, the entry at position pos
   !! of the table. If no corresponding value is found, a nil
 
   end subroutine aot_table_getval
 
+
   !> Load the first key-value pair of table thandle on the
-  !! stack. This serves as an entry point, further traversal
+  !! stack.
+  !!
+  !! This serves as an entry point, further traversal
   !! can be done by flu_next(L, thandle).
   !! If there are no entries in the table the function
   !! returns false, otherwise the result will be true.
     end if
   end function aot_table_first
 
+
   !> Count the entries in a lua table.
   function aot_table_length(L, thandle) result(length)
     type(flu_state) :: L
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.