readyou / jsdoc-toolkit

Automatically exported from code.google.com/p/jsdoc-toolkit
0 stars 0 forks source link

Add a non-deprecated page that explains how to use jsdoc-toolkit #317

Open GoogleCodeExporter opened 9 years ago

GoogleCodeExporter commented 9 years ago
What steps will reproduce the problem?
1. Search the wiki

The one page I was able to find on how to use jsdoc-toolkit (command line 
options) is marked deprecated. It refers to files that no longer exist. 

At the minimum, the the website should point people at the README.txt. 

Using the README in conjunction with the program's help option involves having 
three windows open so a better minimum option would be to have a script that 
pushed the README and the app's help into a wiki page...

Original issue reported on code.google.com by coyote4t...@gmail.com on 25 Feb 2011 at 7:33

GoogleCodeExporter commented 9 years ago
Can you be more specific about what page you are referring to (a URL for 
example would be helpful).

I looked at http://code.google.com/p/jsdoc-toolkit/wiki/CommandlineOptions and 
could see no mention of the word "deprecated".

What files does it refer to that no longer exist?

Original comment by micmath on 25 Feb 2011 at 7:39

GoogleCodeExporter commented 9 years ago
Sorry, there are actually two pages. The only one I found when I 
searched for install/installation was 
http://code.google.com/p/jsdoc-toolkit/wiki/InstallJsdoc

That page worked for me but is marked deprecated. The real problem is 
that that page points to another 
(http://code.google.com/p/jsdoc-toolkit/wiki/CmdlineOptions ... note the 
CmdlineOptions vs. CommandlineOptions) as the place to go to learn how 
to use jsdoc-toolkit. That one is marked deprecated. Just a little down 
is a section called Basic that gives this eroneous example command:

java-jar app/js.jar app/run.js

it sounds like the solution might be to update both of the deprecated pages to 
point at the page you reference. I'm definitely going to put that one to use...

Tim

Original comment by coyote4t...@gmail.com on 26 Feb 2011 at 2:05