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

[BUG] Comments ignored #230

Closed
shwedberlin opened this issue Jul 17, 2017 · 3 comments
Closed

[BUG] Comments ignored #230

shwedberlin opened this issue Jul 17, 2017 · 3 comments

Comments

@shwedberlin
Copy link

Overview of the issue

Documentation generated, but documentation coverage is 0%.
Comments in code are ignored (but some parameter descriptions are used in generated documentation). I have just started, only few modules/components are commented, but nothing is used in generated documentation.
See this project: AngularWebApi/Angular2webapp/Angular2webapp/app/core/logger.service.ts:

/**
  * Logger Service
  */
@Injectable()
export class LoggerService {
    private defaultName: string = "NG_Client";
    private internalName: string = "NG_LoggerSrvc";
    private internalLogger: JL.JSNLogLogger;

/**
 * ajax Logger appender
 */
private ajaxAppender = JL.createAjaxAppender('ajaxAppender');
/**
 * console Logger appender
 */
private consoleAppender = JL.createConsoleAppender('consoleAppender');

And result without description block:
image

Operating System, Node.js, npm, compodoc version(s)

OS: Windows 10
Node: 6.10.3
compodoc: 1.0.0-beta 13

Angular configuration, a package.json file in the root folder

Angular 4, tsconfig.json and package.json in root folder of project.

Compodoc installed globally or locally ?

Both: globally and locally

Related issues

Routes graph missing completely, not sure if this issues caused by same bug

@vogloblinsky
Copy link
Contributor

Ok seems related again to file encoding : your file is UTF-8 with BOM.
Compodoc should support it, i will investigate deeper on this side.

@vogloblinsky
Copy link
Contributor

Ok fixed, coming in next beta 1.0.0-beta.14

@lock
Copy link

lock bot commented Oct 1, 2019

This issue has been automatically locked due to inactivity. Please file a new issue if you are encountering a similar or related problem. Why locking ? Having issues with the most up-to-date context.

@lock lock bot locked as resolved and limited conversation to collaborators Oct 1, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants