Comments (3)
In the documentation I see
Ay tag may have tag modifiers. For instance, you may say @\param[type=number] and this associates the modifier type with value number with this particular param tag. A shorthand can be introduced for this common case, which is "@tparam "; in the same way @\treturn is defined.
But in the source code there is
-- any tag (except name and classs) may have associated modifiers,
-- in the form @tag[m1,...] where m1 is either name1=value1 or name1.
as @function is parsed as class + name, I can't use modifiers on this tag.
What could be done at first, is to ignore the modifiers (LDoc should not throw an error on this)
from ldoc.
Cool, latest version (1.3.5) no longer considers this an error (would apply also to module etc). We aren't yet passing the tag modifiers through, however, so I'll keep the issue open.
from ldoc.
Anybody understand the status of this issue? In v1.5.0 I'm getting the original error again, which comments suggest should have changed. Is this a regression or just an indication that the other half of this issue was never addressed?
from ldoc.
Related Issues (20)
- Representing module with constants HOT 2
- LDoc fails to reference to a table value HOT 1
- Using custom CSS (-s option) fails with error: ldoc/tools.lua:233: attempt to compare number with nil HOT 2
- Part after dot is ignored HOT 2
- How to add description of example script HOT 1
- @type changes behavior when used in @submodule HOT 5
- LuaRocks module: broken link to project homepage HOT 2
- How to use @script tag? HOT 2
- Filename case issues for cross-platform document generation HOT 5
- --fatalwarnings returns 0 exit code with invalid Markdown references
- Error message on invalid tag somewhat obtuse and doesn't point out the issue being the undefined tag HOT 10
- LDoc breaks when loading config file. HOT 2
- [Meta] Is this repo dead? HOT 2
- How do I ignore certain files/directories? HOT 2
- `hxx` extension support HOT 2
- multiple raise statements cause error HOT 6
- Support nested subparams HOT 2
- Question: is there a way to generate document from lua-language-server type annotations?
- Add LuaCATS as alternative tag handling scheme HOT 4
- document nested tables? HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from ldoc.