-
Notifications
You must be signed in to change notification settings - Fork 1.7k
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
Use apiDefine to set a global apiVerion #1346
Comments
In my opinion, you can't use apiDefine to set the version of a documentation block.
But this only says that you can have one apiDefine unique name for different versions. // ------------------------------------------------------------------------------------------
// Current Permissions.
// ------------------------------------------------------------------------------------------
/**
* @apiDefine admin Admin access rights needed.
* Optionally you can write here further Informations about the permission.
*
* An "apiDefinePermission"-block can have an "apiVersion", so you can attach the block to a specific version.
*
* @apiVersion 0.3.0
*/
// ------------------------------------------------------------------------------------------
// History.
// ------------------------------------------------------------------------------------------
/**
* @apiDefine admin This title is visible in version 0.1.0 and 0.2.0
* @apiVersion 0.1.0
*/ Feature request? |
Thank you, |
Describe the bug
With NodeJS project using several pages, I need to set the latest version of all functions documentated. To do this I use apiDefine that is use as below, but on my documentation, the version is still 0.0.0. Whereas, the api_doc version is at 0.1.0.
Steps to reproduce
apidoc.json:
{ "name": "Documentation du Sokoro", "version": "0.1.0", "description": "", "header": { "title": "Scripts extra logiciel", "filename": "header.md" } }
Header.js:
`/**
*/
/**
*/`
Information
The text was updated successfully, but these errors were encountered: