Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

mardown export doesn't export any tags #347

Open
tanguyvda opened this issue Mar 17, 2021 · 0 comments
Open

mardown export doesn't export any tags #347

tanguyvda opened this issue Mar 17, 2021 · 0 comments

Comments

@tanguyvda
Copy link

Hello there,

I would like to use LDoc to export in a markdown format the comments in my modules. But for some unknown reason I can't get it to export the tags (using only standard one like @param @return)

I've tested the following LDoc versions

  • using the luarocks one (markdown export is bugged and doesn't work at all)
  • using the latest github release and applying the following commit a3bb407
  • cloning the current master branch

If i'm using the three.lua example from the documentation (https://stevedonovan.github.io/ldoc/examples/three.lua.html)

here is the result from the following command :
lua /usr/src/LDoc/ldoc.lua /usr/src/three.lua --ext md

### answer ()

answer to everything.

the funny thing is that if I use the --dump option, it shows me that the tags aren't ignored

lua /usr/src/LDoc/ldoc.lua /usr/src/three.lua --ext md --dump

----
module: x1B[1mthree     Alternative to no-magic style.x1B[0m

 Description here


x1B[1mfunction  answer()
x1B[0manswer to everything.
returns:
        magic number
tags:
                export  true

Am I doing something wrong ? is it bugged ? (it works fine if I'm using the html export)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

1 participant