Coder Social home page Coder Social logo

extract-documentation-comments's People

Contributors

anadian avatar dependabot[bot] avatar frqnck avatar goofballtech avatar

Stargazers

avatar avatar avatar avatar avatar

Watchers

avatar avatar avatar

Forkers

goofballtech frqnck

extract-documentation-comments's Issues

trying on a test file

I was trying to use your library via npx on one of my routes for inline documentation on params and returns. I was getting an error so i mad ea test doc to run against and still l get an error.

test.js
/** Some test documentation things */

command
npx extract-documentation-comments -n -v -I test.js

output in console

npx: installed 65 in 9.722s
note: MainExecutionFunction: Logger: console_stderr transport log level set to: debug
debug: MainExecutionFunction: Soft error: Error: Cannot find module '/home/goofballtech/.npm/_npx/2608/lib/node_modules/extract-documentation-comments/source/package.json'
Require stack:
- /home/goofballtech/.npm/_npx/2608/lib/node_modules/extract-documentation-comments/source/main.js
debug: main_Async: received: [object Object]
info: main_Async: Reading input from a file.
debug: main_Async: options.input: 'test.js'
debug: getDocumentationStringFromSourceString: received: /** Some test documentation things */
,[object Object]
debug: getDocumentationStringFromSourceString: matches: 
debug: getDocumentationStringFromSourceString: returned: 
error: main_Async: "output_string" is either null or not a string.
crit: main_Async: "output_string" is either null or not a string.
debug: MainExecutionFunction: End of execution block.

I can only assume that Object to string parse is throwing something off. It looks like the contents of the file are making it into the function fine. I got similar results with the full route file. The contents were displayed and it ended with the same error. I also tried different options in place of -n. Same with each i attempted.

Spanish accent marks

I'm using this library to automatically generate markdown documentation updating a static web site every time I deploy my application. It works great. However, when the documentation block has one or more accent marks the all block is ignored.

Example:

Input:

/**
## Some title

Parámetros
*/
void main(args[]){
}


/**
## Another title

Parameters
*/

--> In this case the letter a in "Parámetros" has an accent mark

Output:

## Another title

Parameters

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.