92a6714d9a
refactor: Drop completely unused variable references
2020-10-02 01:06:18 +03:00
f1b3f76aca
refactor: Remove what seems to be unused debug cruft
2020-10-02 01:06:18 +03:00
9fa1150194
Match backslash as separator in references for moonscript ( #273 )
2020-09-30 20:11:28 +03:00
bb55647363
process_see_reference: look for name.s before functions ( #257 )
...
The `@see` reference for an item like the following might point to
itself, although this is in `@module tag` and there is
`tag.master_width_factor` also.
```
--- The default master width factor
--
-- @beautiful beautiful.master_width_factor
-- @param number (default: 0.5)
-- @see master_width_factor
-- @see gap
```
548b15e883/lib/awful/tag.lua (L564-L569)
2020-09-30 00:54:57 +03:00
94dbff2861
More generic approach with a table of names hierarchy
2016-10-26 09:47:26 +02:00
8d9d8e84a2
Add fully_qualified_name and local_name
2016-10-25 21:21:41 +02:00
7e5ffcf602
typo in last commit (Eagle eyes of Gary)
2016-10-13 14:53:00 +02:00
8de6c79493
issue #251 avoid potential clash between built-in and custom defined kinds like sections
2016-10-13 11:00:05 +02:00
b903eb79df
temporary file hack borked on Windows; working on parsing tag modifiers _properly_
2016-06-27 19:45:26 +02:00
7bed1fa826
issue #191 strip left spaces from usage code
2016-06-27 16:25:56 +02:00
ff0eebceb2
prettier output for ldoc -m if not Windows
2016-06-24 15:51:38 +02:00
edba959b1b
Merge pull request #237 from Alloyed/fix-dumping-objects
...
Fix logic error when dumping non-function objects
2016-06-19 11:18:47 +02:00
2b99730d18
Merge pull request #231 from nebularg/fix_within
...
Fix @within
2016-06-18 17:33:46 +02:00
5e2f665a49
Merge pull request #222 from th-we/fix-dup-return
...
Avoid return documentation slipping into preceding function documenation
2016-06-18 17:31:20 +02:00
5be42470c3
Fix logic error when dumping non-function objects
2016-06-03 03:28:00 -04:00
bbbcb1a59f
--fatalwarnings flag to force ldoc to return non-zero exit code if there are any warnings; issue #255 @psychon
2016-04-10 18:02:09 +02:00
3dada49e07
Fix @within
2016-04-06 01:50:14 -05:00
3e4bb302da
Avoid return documentation slipping into preceding function documenation
2015-12-23 14:20:49 +01:00
b9803db8ff
Adding module-level see reference support.
2015-10-16 13:34:31 -07:00
eef66575d6
Fix undefined quote in Item:build_return_groups
2014-11-19 19:55:45 +01:00
31ee8f5cbc
Issue #174 : @include tag for including processed documentation file into output; last item now has a distinct line number, and some nasty tabs have been removed
2014-10-12 18:35:19 +02:00
56ac2601c0
Tweaks to opt/optchain: (optional) is emitted after optional arguments without defaults. convert_opts (counter-intuitively) disables automatic opt->optchain promotion
2014-10-12 16:45:09 +02:00
cfdc6f8f53
new feature: prettify_files makes per-item links to source; unless this field is 'show', don't put in index
2014-10-12 16:09:09 +02:00
2778e043ed
issue #169 : make sure ldoc is not nil before checking config
2014-10-01 16:02:38 +02:00
c34957cd16
issue #178 Allow class merging
2014-09-28 18:54:17 +02:00
c979700ae6
Issue #177 : annotation rendering fixed
2014-09-15 20:02:28 +02:00
160eda087e
Merge branch 'master' of github.com:stevedonovan/LDoc
2014-06-27 15:55:12 +02:00
9a5b556a2d
summary/description with type/section fixed
2014-06-27 15:50:21 +02:00
9bd5dd0ec7
dont_escape_underscore defaults to true if markdown.lua is not used; global_lookup defaults to true if parse_extra.C
2014-06-22 17:14:08 +02:00
acc6ed2ad3
prettify code blocks in module docstring. Two new ldoc flags: dont_escape_underscore (when not using markdown.lua) and global_lookup (when specifically wanting global lookup for single symbols
2014-06-20 15:11:40 +02:00
3f32313ced
#158 summary line lost with @type tag
2014-05-25 13:58:25 +02:00
624ff11afd
parameter names which were List methods overwriting object - factor out as map field
2014-04-23 13:19:16 +02:00
04dc148df6
Issue #145 : do not expand annotations if there's no previous item
2014-01-06 15:03:09 +02:00
86a3fde07e
issue #139 ; improved lookup for class methods; args override now only kicks if the argument does not have its default value
2014-01-05 14:55:20 +02:00
f507e36720
more general method of controlling visibility of local functions or items marked with @local
2014-01-02 18:45:04 +02:00
4294b2e2da
Issue #114 : trying harder to resolve references by unqualified method name
2013-11-28 11:57:13 +02:00
46515b2411
Issue #113 , borked classmod: now custom sections are always respected. Automatic sections are generated for 'Metamethods' and 'Methods'
2013-11-27 09:46:37 +02:00
4fac99406c
try match single names against fully qualified names of module funtions
2013-11-21 16:06:34 +02:00
feabf5c91a
when using export tag, decide whether function is meant to be a class method from 'self' formal arg, otherwise it becomes static.
2013-11-18 14:54:28 +02:00
9ef1f08784
can resolve references to local class; no longer have 'Topic: ' for readme documents
2013-11-17 19:48:35 +02:00
4666e464cc
no more fooling with globals in LDoc; the class ModuleMap is no longer global, but inserted into doc module so it can use it
2013-11-16 21:03:43 +02:00
fd323aa286
Issue #105 ; can switch off auto-linking to Lua manual with 'no_lua_ref' variable. This also happens if plain C documentation is being generated
2013-11-16 20:36:53 +02:00
955802e07b
Issue #93 : can define fields/properties of objects; the 'readonly' modifier is now special. See tests/styles/type.lua
2013-11-16 19:21:50 +02:00
7e2e6e975c
Issue #96 : was expecting a space after ## in markdown documents; better support for C types
2013-09-27 15:37:46 +02:00
7a7865f300
Issue 95: strip leading stars in C block comments; improvements in identifying typenames within type expressions
2013-09-26 16:05:45 +02:00
531a7d34de
Issue 81 'example' tag raises more explicit error, exclude more 'accidental' doc comments
2013-09-26 15:34:53 +02:00
d2e40e2f2f
basic support for documenting C. If you put 'parse_extra={C=true}' in config.ld, then it will attempt to extract function name, arguments and types from the source
2013-09-20 13:33:06 +02:00
df72613e57
structure return needs 'typename'; by default merge_error_groups will combine different error tag texts
2013-08-27 12:47:47 +02:00
8395d6d9d7
inline error comments starting to work
2013-08-26 14:22:52 +02:00
a825a316a1
error tag now auto-groups; refactorings
2013-08-26 13:37:41 +02:00
Caleb Maclennan
Kyra Zimmer
Daniel Hahler
Alexis BRENON
Steve Donovan
Kyle McLamb
Kyle Buller
Thomas Weber
cjtallman
Michal Cichra
Steve Donovan