Skip to content
This repository has been archived by the owner on Nov 20, 2020. It is now read-only.

Commit

Permalink
Merge tag '1.4.2' of https://github.com/stevedonovan/LDoc into update
Browse files Browse the repository at this point in the history
1.4 release LR

* tag '1.4.2' of https://github.com/stevedonovan/LDoc: (106 commits)
  ldoc.custom_references to create new @{KIND:NAME} reference schemes; doc updates
  unknown typename check for kind_names; updated ldoc's config.ld
  kind_names variable can override names used in sidebar, e.g. 'kind_names={topic='Manual'}' will override default of 'Topics'
  bumped version to 1.4.2
  Updated LuaDoc canonical URL
  Updated LuaDoc url
  updated changes.md - preparing for release
  html: case sensitive file systems require matching require args.
  Issue lunarmodules#150: 'info' section ordering is now consistent
  Resolve issue lunarmodules#22 'In-line links with underscores are broken'
  Issue lunarmodules#145: do not expand annotations if there's no previous item
  Issue lunarmodules#137 boilerplate Lua block comment
  issue lunarmodules#139; improved lookup for class methods; args override now only kicks if the argument does not have its default value
  more general method of controlling visibility of local functions or items marked with @Local
  Removing inconsistent header colon
  Better section naming, some hints for C code
  Fixing tag introduction example (hopefully?)
  Some more reordering, introducing tags more explicitly
  Getting all the sections in a more beginner's friendly, logical order
  Rewrite of first introductory paragraph
  ...
  • Loading branch information
drahosp committed Mar 10, 2014
2 parents 100f402 + 511dfe7 commit 5d4f0cb
Show file tree
Hide file tree
Showing 48 changed files with 3,893 additions and 1,973 deletions.
56 changes: 56 additions & 0 deletions changes.md
@@ -0,0 +1,56 @@
## Version 1.4.2

### Features

* Can define fields/properties of objects; `readonly` modifier supported (#93)
* Can switch off auto-linking to Lua manual with `no_lua_ref`
* Module sorting is off by default, use `sort_modules=true`
* References to 'classes' now work properly
* Option to use first Markdown title instead of file names with `use_markdown_titles`
* Automatic `Metamethods` and `Methods` sections generated for `classmod` classes
* `unqualified=true` to strip package names on sidebar (#110)
* Custom tags (which may be hidden)
* Custom Display Name handlers

### Fixes

* stricter about doc comments, now excludes common '----- XXXXX ----' pattern
* no longer expects space after `##` in Markdown (#96)
* Section lookup was broken
* With `export` tag, decide whether method is static or not
* `classmod` classes now respect custom sections (#113)
* Minor issues with prettification
* Command-line flags set explicitly take precendence over configuration file values.
* Boilerplate Lua block comment ignored properly (#137)
* Inline links with underscores sorted (#22)
* Info section ordering is now consistent (#150)

## Version 1.4.0

### Features

* `sort=true` to sort items within sections alphabetically
* `@set` tag in module comments; e.g, can say `@set sort=true`
* `@classmod` tag for defining modules that export one class
* can generate Markdown output
* Can prettify C as well as Lua code with built-in prettifier
* lfs and lpeg references understood
* 'pale' template available
* multiple return groups
* experimental `@error` tag
* Moonscript and plain C support


### Fixes

* works with non-compatibily Lua 5.2, including `markdown.lua`
* module names can not be types
* all `builtin` Lua files are requirable without `module`
* backticks expand in copyright and other 'info' tabs
* `-m` tries harder to resolve methods
* auto-scroll in navigation area to avoid breaking identifiers
* better error message for non-luadoc-compatible behaviour
* custom see references fixed



7 changes: 0 additions & 7 deletions config.ld

This file was deleted.

19 changes: 19 additions & 0 deletions doc/config.ld
@@ -0,0 +1,19 @@
project='LDoc'
title='LDoc documentation'
description='A Lua documentation tool'
format='discount'
backtick_references=false
file='../ldoc.lua'
dir='../out'
readme='doc.md'
style='!pale'
kind_names={topic='Manual',script='Programs'}
examples = {
'../tests/styles/colon.lua',
'../tests/styles/four.lua',
'../tests/styles/three.lua',
'../tests/styles/multiple.lua',
'../tests/example/mylib.c',
'../tests/moonscript/List.moon',
}

0 comments on commit 5d4f0cb

Please sign in to comment.