Giter Site home page Giter Site logo

Comments (4)

dennisguse avatar dennisguse commented on May 29, 2024

The issue is that jsdoc changed their command line interface while moving from 2.X to 3.X.
In 2.X they used "-d=XXX" to define the target directory and in 3.X they use "-d XXX".

Can you try: jsdoc --private -d doc thefragebogen.js?
You can also adjust the Gruntfile by removing the =: https://github.com/TheFragebogen/TheFragebogen/blob/master/Gruntfile.js#L78

from thefragebogen.

gabrielmittag avatar gabrielmittag commented on May 29, 2024

Thanks for you help. Now it starts buliding the documentation and I think I have most of it in the "doc" folder. However, I still receive another error.

PS C:\Users\gabriel\Documents\Fragebogen\TheFragebogen> grunt doc
Running "includereplace:dist" (includereplace) task
Processed 43 files

Running "revision" task
HEAD at revision b883a790163947f6fc1fa51fe0d178629f83947b

Running "concat_in_order:your_target" (concat_in_order) task
File "thefragebogen.js" created.

Running "uglify:dist" (uglify) task
>> 1 file created 185.14 kB → 125.63 kB

Running "run:jsdoc" (run) task
ERROR: Unable to parse a tag's type expression for source file C:\Users\gabriel\Documents\Fragebogen\TheFragebogen\thefragebogen.js in line 3105 with tag title "param" and text "{string|array[string]} answer": Invalid type expression "string|array[string]": Expected "#", "$", "(", "-", ".", "/", "0", ":", "<", "=", "@", "[]", "\\", "\u200C", "\u200D", "_", "|", "~", Unicode combining mark, Unicode decimal number, Unicode letter number, Unicode lowercase letter, Unicode modifier letter, Unicode other letter, Unicode punctuation connector, Unicode titlecase letter, Unicode uppercase letter, [1-9] or end of input but "[" found.
ERROR: Unable to parse a tag's type expression for source file C:\Users\gabriel\Documents\Fragebogen\TheFragebogen\thefragebogen.js in line 3109 with tag title "param" and text "{string|array[string]} answer": Invalid type expression "string|array[string]": Expected "#", "$", "(", "-", ".", "/", "0", ":", "<", "=", "@", "[]", "\\", "\u200C", "\u200D", "_", "|", "~", Unicode combining mark, Unicode decimal number, Unicode letter number, Unicode lowercase letter, Unicode modifier letter, Unicode other letter, Unicode punctuation connector, Unicode titlecase letter, Unicode uppercase letter, [1-9] or end of input but "[" found.
Warning: non-zero exit code 1 Use --force to continue.

Aborted due to warnings.

from thefragebogen.

dennisguse avatar dennisguse commented on May 29, 2024

Looks like jsdoc also changed some markup.
The most recent version can be found here: http://usejsdoc.org/tags-param.html
The two lines jsdoc complains about declare a param that can be of either string or an array of string.
Could you check if adjusting the syntax helps (tags-param.html CRTL-F for "Allows one type OR another type (type union)")?

from thefragebogen.

gabrielmittag avatar gabrielmittag commented on May 29, 2024

It works with @param {(string|string[])} answer
Thanks!

from thefragebogen.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.