dasch-swiss / knora-ui

Reusable GUI elements for Knora
https://dasch-swiss.github.io/knora-ui
7 stars 1 forks source link

Update documentation for v10.0.0 #397

Closed kilchenmann closed 4 years ago

kilchenmann commented 4 years ago

This PR updates the documentation, but I get the following error during build-docs process:

~/.config/yarn/global/node_modules/jsdoctypeparser/lib/index.js:53
          throw new Lexer.SyntaxError(e.message, typeExp, e.offset);
          ^
TypeLexerSyntaxError: Expected "!", "(", "*", "...", "=", "?", "function", "module", "{" or [a-zA-Z_$] but "'" found.:
'list'|'grid'|'table'
^
error Command failed with exit code 1.
kilchenmann commented 4 years ago

'list'|'grid'|'table'

The jsDoc was wrong. There are other issues right now. I'll fix them..

kilchenmann commented 4 years ago

@flavens I have some issues with this file: https://github.com/dasch-swiss/knora-ui/blob/wip/docs-v10.0.0/src/app/knora-ui-examples/viewer-demo/properties/properties.component.ts

Although it is not used in the documentation (but it should and it's failing). I'm not able to fix it now (because of the family). When you have the time, can you have a look on it? It was still the old declarations import from @knora/core which is now replaced by the imports from @knora/api and they have to build / defined in another way...

flavens commented 4 years ago

@kilchenmann yes, I can look at it. However, could you send me again the npm page to install dox because, for some unknown reasons, I do not have the package installed on my computer, so I cannot run the build docs script...

kilchenmann commented 4 years ago

To fix the file, you don't need dox or doxdox (please look in the build documentation shell script, which one you have to install). Just open the src/app/knora-ui-examples/viewer-demo/properties/properties.component.ts file in VSC and you'll see, what I mean 😉

Screen Shot 2019-12-19 at 16 04 19
flavens commented 4 years ago

@kilchenmann I am on it

kilchenmann commented 4 years ago

For the documentation you'll need dox

kilchenmann commented 4 years ago

@kilchenmann I am on it

Thanks @flavens and sorry, I'm a bit stressed...