Comments (8)
Retitled to something actionable; appreciate the attempt at humor (sarcasm?) but to stay sane and productive we should focus on actionable issues.
Does jsdoc provide correct output? Can you provide an example of the code you're documenting so that we can determine where the issue lies?
from gulp-documentation.
This is one small module:
/**
* This is the entry point for the admin interface
*
* @namespace Index
* @param {String}
* @return {Object} Exports object
*/
var Index = (function () {
var _name = 'Project name';
/**
* Initialize application
* @memberOf Index
* @return {void}
*/
function init () {
var dashboard = require('dashboard');
// Set initial Document Title to the name of the app
document.title = _name;
addEventListeners();
}
/**
* This is left blank intentionally
* @memberOf Index
*/
function addEventListeners () {}
/**
* Initialize module Index internally
*/
init();
}());
module.exports = Index;
All other modules are based on the same syntax.
from gulp-documentation.
It outputs a directory called 'assets' and an index.html file. In the assets directory I find these files:
anchor.js
bass.css
github.css
site.js
style.css
If that is what it's supposed to output then I guess it does provide correct output.
from gulp-documentation.
Can you try changing @memberOf Index
to @memberof Index
? The memberof tag, like all other JSDoc tags, is all lowercase.
from gulp-documentation.
OK, that made something of a difference. Am I wrong if I think that it used to be with a capital O?
Well, I guess I'll walk over all the syntax again ... thanks for pointing that out.
from gulp-documentation.
I don't believe so, in 2012, before the site moved to usejsdoc.org, it was all lowercase commit
from gulp-documentation.
Yeah, but I'm using DocBlockr in Sublime Text 2 / 3 and there it is @memberof. Even google code has it referenced with an uppercase o:
https://code.google.com/archive/p/jsdoc-toolkit/wikis/TagReference.wiki
Don't know what's going on. It used to work fine with the original gulp-jsdoc with an upper o. I've opened a ticket, asking them to change it to a lower case. We'll see if that will happen. In ST 2 I can change the bugger myself. But due to the change in how packages are managed in ST 3 I can do nothing but wait for 'someone' to do 'something'. That's one of the cons of depending on other peoples code ... I guess it wouldn't make any sense for you to go .toLowerCase() on all @NAMEs in gulp-documentation?
from gulp-documentation.
SOLUTION FOUND: In case any other poor soul is looking for a solution to this:
Install PackageResourceViewer for ST3, and voila, edit the resource yourself.
https://github.com/skuroda/PackageResourceViewer
from gulp-documentation.
Related Issues (20)
- How might one go about configuring a project to automatically set the title? HOT 3
- The code generator has deoptimised the styling of "..." as it exceeds the max of "100KB" HOT 2
- Allow usage of custom instance of documentation.js HOT 1
- TypeError: Cannot read property 'forEach' of undefined HOT 17
- Ignores description
- Please add License file HOT 1
- how do i run for all my files? HOT 6
- ES6 babel project: Cannot read property 'reduce' or 'forEach' of undefined HOT 2
- `polyglot` gives me a blank documentation HOT 6
- Pass config and theme options HOT 1
- An in-range update of vinyl is breaking the build 🚨 HOT 1
- An in-range update of lint-staged is breaking the build 🚨 HOT 14
- Project name and version not included in HTML output HOT 2
- An in-range update of husky is breaking the build 🚨
- An in-range update of standard-version is breaking the build 🚨 HOT 2
- An in-range update of prettier is breaking the build 🚨 HOT 24
- An in-range update of concat-stream is breaking the build 🚨 HOT 1
- Version 10 of node.js has been released
- options do not seem to be working HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from gulp-documentation.