1

I tried to create API documentation using apidocjs and i got issues while compiling project for creating apidoc using apidoc.json on project folder.

Code here :

~$ apidoc -i ./ -o apidoc/

And result

warning: parser plugin 'param' not found.
error:   Error: Can not read: apidoc.json, please check the format (e.g. missing comma).

Please anyone help me to fix this issue

Tags related to apidocjs.com

leppie
  • 115,091
  • 17
  • 196
  • 297
Prasanth P
  • 715
  • 2
  • 9
  • 24

6 Answers6

5

Removing the apidoc destination folder as @Prasanth suggests will destroy your history if you are using the @apiVersion feature. The only way you could rebuild it is to go through and checkout each version, then run the apidoc. So, if you want to use versioning. This is not your answer.

You may have syntax issues or some other configuration issue. In my case, since updating I had some functions documented in javadoc style with @param... this used to be ignored but now throws the warning.

Phil Ives -Rain Everywhere
  • 51
  • 4
3
~$  apidoc -i ./ -e apidoc/ -o apidoc/

when api document generates, it generates main.js file with @param. and as that @param will also be checked next time of generation, you can just skip that output directory and all are good to go.

codersaif
  • 946
  • 9
  • 15
  • This Issue still remains for me : ayyappa@pcs-18-PC MINGW64 /d/nodejs $ apidoc -i example/ -o doc/ error: Can not read: apidoc.json, please check the format (e.g. missing comma). – Ayyappa A Jan 25 '16 at 07:21
2

Issue is fixed for me as well, This error comes from the generated docs/main.js. Usually we should parse only necessary files, to generate this apiDoc.

I used -f .php in my command, like apidoc -f .php -i ./ -o ./. This is working like a miracle.

  • what if we want to specify just one file one a particular folder ? `apidoc -i ~/Folder1/example.js -o ~/Folder2/` @MalviChauhan – lazy rabbit Jan 15 '16 at 07:22
0

I had the same proble. I'm using custom template and template folder was in the same location as my *.js files which are parsed including main.js template file. -e option did not worked for me so I moved template folder to other location and everything works fine.

Strabek
  • 2,391
  • 3
  • 32
  • 39
0

I had the same issue in rebar using erlang and what I did was in the project root folder:

rm -rf doc/

then I run again apidoc

info: Done

Unamata Sanatarai
  • 6,475
  • 3
  • 29
  • 51
xxnull
  • 69
  • 7
0

For fix this bug, you can try to save package.json and apidoc.json without UTF-BOM symbol. Some versions, parts or dependecies of apidoc use code similar with this

JSON.parse(fs.readFileSync(file, 'utf-8')) // throw "Uncaught SyntaxError: Unexpected token  in JSON at position 0"
KiberInfinity
  • 1
  • 1