Permalink
Browse files

first commit

  • Loading branch information...
0 parents commit a46cbf66b9bd9ec7c63203e266dee273753a59bd kapec committed Nov 20, 2011
Showing with 6,953 additions and 0 deletions.
  1. +15 −0 CMakeLists.txt
  2. +70 −0 README
  3. +452 −0 dist.cmake
  4. +18 −0 dist.info
  5. +213 −0 doc/us/architecture.html
  6. BIN doc/us/architecture.vsd
  7. BIN doc/us/architecture_h.png
  8. BIN doc/us/architecture_v.png
  9. BIN doc/us/email.png
  10. +103 −0 doc/us/examples.html
  11. +79 −0 doc/us/examples/lfs/lfs.luadoc
  12. +169 −0 doc/us/index.html
  13. +129 −0 doc/us/license.html
  14. BIN doc/us/lua.png
  15. +284 −0 doc/us/manual.html
  16. +134 −0 src/luadocer.lua
  17. +38 −0 src/luadocer/config.lua
  18. +46 −0 src/luadocer/doclet/debug.lua
  19. +84 −0 src/luadocer/doclet/formatter.lua
  20. +522 −0 src/luadocer/doclet/html.lua
  21. +54 −0 src/luadocer/doclet/html/file.lp
  22. +19 −0 src/luadocer/doclet/html/file_listing.lp
  23. +11 −0 src/luadocer/doclet/html/footer.lp
  24. +100 −0 src/luadocer/doclet/html/function.lp
  25. +99 −0 src/luadocer/doclet/html/function_detail.lp
  26. +46 −0 src/luadocer/doclet/html/functions_and_tables.lp
  27. BIN src/luadocer/doclet/html/global.png
  28. +53 −0 src/luadocer/doclet/html/header.lp
  29. +162 −0 src/luadocer/doclet/html/highcharts.js
  30. +17 −0 src/luadocer/doclet/html/index.lp
  31. +33 −0 src/luadocer/doclet/html/indexOfFunctions.css
  32. +121 −0 src/luadocer/doclet/html/indexOfFunctions.lp
  33. +209 −0 src/luadocer/doclet/html/indexOfMetrics.lp
  34. +312 −0 src/luadocer/doclet/html/jquery-ui-1.8.11.custom.css
  35. +68 −0 src/luadocer/doclet/html/jquery-ui.min.js
  36. +16 −0 src/luadocer/doclet/html/jquery.js
  37. +16 −0 src/luadocer/doclet/html/list_of_files.lp
  38. +18 −0 src/luadocer/doclet/html/list_of_modules.lp
  39. BIN src/luadocer/doclet/html/local.png
  40. +518 −0 src/luadocer/doclet/html/luadoc.css
  41. +39 −0 src/luadocer/doclet/html/menu.js
  42. +128 −0 src/luadocer/doclet/html/menu.lp
  43. +41 −0 src/luadocer/doclet/html/metrics/metrics_LOC.lp
  44. +15 −0 src/luadocer/doclet/html/metrics/metrics_cyclomatic.lp
  45. +81 −0 src/luadocer/doclet/html/metrics/metrics_file.lp
  46. +186 −0 src/luadocer/doclet/html/metrics/metrics_function.lp
  47. +185 −0 src/luadocer/doclet/html/metrics/metrics_functions.lp
  48. +184 −0 src/luadocer/doclet/html/metrics/metrics_graphs.lp
  49. +50 −0 src/luadocer/doclet/html/metrics/metrics_halstead.lp
  50. +22 −0 src/luadocer/doclet/html/metrics/metrics_infoflow.lp
  51. +209 −0 src/luadocer/doclet/html/metrics/metrics_module.lp
  52. +18 −0 src/luadocer/doclet/html/metrics/metrics_statements.lp
  53. +20 −0 src/luadocer/doclet/html/metrics/metrics_table.lp
  54. +63 −0 src/luadocer/doclet/html/metrics/metrics_variables.lp
  55. +64 −0 src/luadocer/doclet/html/module.lp
  56. +19 −0 src/luadocer/doclet/html/module_hierarchy.lp
  57. +182 −0 src/luadocer/doclet/html/prettyprint.js
  58. +22 −0 src/luadocer/doclet/html/table (Ivan Simko's conflicted copy 2011-04-28).lp
  59. +23 −0 src/luadocer/doclet/html/table.lp
  60. +12 −0 src/luadocer/doclet/raw.lua
  61. +58 −0 src/luadocer/init.lua
  62. +63 −0 src/luadocer/io.lua
  63. +130 −0 src/luadocer/lp.lua
  64. +496 −0 src/luadocer/taglet/standard.lua
  65. +40 −0 src/luadocer/taglet/standard/aliases.lua
  66. +174 −0 src/luadocer/taglet/standard/tags.lua
  67. +201 −0 src/luadocer/util.lua
@@ -0,0 +1,15 @@
+# Copyright (C) 2011 LuaDist.
+# Created by Peter Kapec
+# Redistribution and use of this file is allowed according to the terms of the MIT license.
+# For details see the COPYRIGHT file distributed with LuaDist.
+# Please note that the package source code is licensed under its own license.
+
+project ( luadocer NONE )
+cmake_minimum_required ( VERSION 2.6 )
+include ( dist.cmake )
+
+# Install all files and documentation
+install_lua_executable ( luadocer src/luadocer.lua )
+install ( DIRECTORY src/luadocer DESTINATION ${INSTALL_LMOD} )
+install_data ( README )
+install_doc ( doc/ )
70 README
@@ -0,0 +1,70 @@
+* About LuaDocer
+ -------------
+ LuaDocer is a documentation generation tool for the Lua language. It produces
+ standalone HTML documentation for the given projects, which documents all
+ files, functions, variables and tables that are used in the project.
+ Documentation comments are used to supply documentation data into the final
+ documentation of the project.
+
+ Output of LuaDocer also contains a lot of lists, metrics and statistics, such as
+ an alphabetical index of all global functions used in the project, source code
+ syntax-aware highlighter, formatter and much more. Many aspects of the final
+ documentation can be easily configured to suit everyone's needs.
+
+ LuaDocer is a fork (an enhanced version) of LuaDoc.
+
+* Availability
+ ------------
+ LuaDocer is freely available for both academic and commercial purposes under.
+ See doc/us/license.html for details.
+
+* Dependecies
+ -----------------------------------------
+ LuaDocer requires following modules to be installed:
+ lua >= 5.1 (not tested with 5.2)
+ lualogging >= 1.1.3
+ luafilesystem >= 1.2.1
+ luapretty >= 0.1
+ luametrics >= 0.1
+
+* Installation
+ ------------
+ Simplest way to install LuaDocer is to use the LuaDist (www.luadist.org) deployment
+ tool by invoking:
+
+ > ./luadist _luadocer install luadocer
+
+ which will install LuaDocer and all it's dependecies into the _luadocer folder.
+ LuaDocer can be also installed using CMake (www.cmake.org). For manual installation
+ copy the luadocer folder from src into your LUA_PATH folder.
+
+* Running
+ -------
+ LuaDocer installs to a standalone directory and should be able to execute on
+ most systems supported systems without the need to set up any environment.
+
+ To invoke the LuaDocer main script simply execute luadocer.lua from src folder
+ using the Lua runtime interpreter in the install directory:
+ $ cd _luadocer/bin/
+ $ lua luadocer.lua
+
+ LuaDist also installs a binary versions of this sript called luadocer.
+
+* Compatibility warning for Windows systems
+ -----------------------------------------
+ LuaDocer has not been tested in the Windows environment and is likely to
+ misbehave when parsing path names in Windows systems due to a different
+ path separator as in Unix systems [\ vs /].
+
+* Authors
+ -------
+ LuaDocer is developed and maintained by:
+ Ivan Šimko
+ Viliam Kubis
+ Peter Kapec (project supervisor)
+
+ Contributors:
+ Gabriel Duchoň
+
+
+
Oops, something went wrong.

0 comments on commit a46cbf6

Please sign in to comment.