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

Add link to source #71

Closed
ivmartel opened this issue Apr 23, 2021 · 4 comments
Closed

Add link to source #71

ivmartel opened this issue Apr 23, 2021 · 4 comments

Comments

@ivmartel
Copy link

Is your feature request related to a problem? Please describe.

It would be nice to have a link to the source code from all documented elements, as in this example (see the constructor).

Describe the solution you'd like

Add an option to include or not source links.

Describe alternatives you've considered

None.

Additional context

None.

@ankit-kumar-kr
Copy link
Contributor

I think this feature is already there. Visit: #60 (comment)

@ivmartel
Copy link
Author

I do not have links to source below functions / methods documentation even with the outputSourceFiles options set to true (its default, see ref).

Here is my config

{
    "plugins": ["node_modules/jsdoc/plugins/markdown"],
    "markdown": {
      "idInHeadings": true
    },
    "source": {
      "include": [
        "src",
        "tests"
      ]
    },
    "templates": {
      "default": {
        "outputSourceFiles": true,
        "staticFiles": {
          "include": ["resources/doc/img"]
        }
      }
    },
    "opts": {
      "recurse": true,
      "readme": "resources/doc/readme-doc.md",
      "destination": "build/doc",
      "template": "node_modules/clean-jsdoc-theme",
      "tutorials": "resources/doc/tutorials",
      "package": "package.json",
      "theme_opts": {
        "theme": "dark"
      }
    }
}

@ankitskvmdam
Copy link
Owner

Oh.. Got it .. There is some bug. Need to look into it.

@ankitskvmdam
Copy link
Owner

Thanks, for reporting this.. I really appreciate your effort. Thank you. This is also fixed in v3.2.7, I will release this version in the coming weekend.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants