Jsdoc-Toolkit advanced use

Source: Internet
Author: User

Jsdoc-Toolkit is basically used on the Internet, so it won't steal others. Share some of the advanced usage I haven't found:

 

1. how to specify the script file list for generating a document. For example, a script library contains many files and only wants to generate a part of the doc. The command line does not have relevant parameters. You can use the configuration file, the parameter "_" is the source file list.

{<Br/> // source files to use, 'src-New/util. js' <br/> _: ['src/base. js', <br/> 'src/UI/mask. js', <br/> 'src/UI/Editor. js' <br/>], </P> <p> // document all functions, even uncommented ones <br/> A: True, </P> <p> // including those marked @ private <br/> // P: True, </P> <p> // some extra variables I want to include <br/> D: {generatedby: "Jianjun. wang ", copyright:" 2008 "},</P> <p> // use this directory as the output directory <br/> D:" Doc ", </P> <p> // use this template <br/> T: "lib/jsdoc-Toolkit/templates/jsdoc" <br/>}

 

 

2. How to insert external links for help

 

@ Link <a target = "_ blank" href = ".../../src/UI/AAA/example.html"> example </a>

 

Jsdoc-Toolkit: http://code.google.com/p/jsdoc-toolkit/

Contact Us

The content source of this page is from Internet, which doesn't represent Alibaba Cloud's opinion; products and services mentioned on that page don't have any relationship with Alibaba Cloud. If the content of the page makes you feel confusing, please write us an email, we will handle the problem within 5 days after receiving your email.

If you find any instances of plagiarism from the community, please send an email to: info-contact@alibabacloud.com and provide relevant evidence. A staff member will contact you within 5 working days.

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.