Skip to content
This repository has been archived by the owner on Jun 11, 2024. It is now read-only.

Usage of @apiDefine unclear #156

Closed
butsjoh opened this issue Nov 24, 2014 · 1 comment
Closed

Usage of @apiDefine unclear #156

butsjoh opened this issue Nov 24, 2014 · 1 comment
Labels

Comments

@butsjoh
Copy link

butsjoh commented Nov 24, 2014

I was trying to add a group description and the documentation says @apiGroupDescription is deprecated and @apiDefine is recommended. I cannot get it to show the group description using the following:

###
@apiDefine Resources
This is my description block
###

###
@api {get} /resources
@apiName GetResources
@apiGroup Resources
@apiVersion 0.1.0
###

I am missing something?

@rottmann rottmann added the bug label Nov 24, 2014
@rottmann
Copy link
Member

Fixed in 0.8.2
A minor bug is at the moment, that you have to define a title if you have a description, or the first line of the description will be the title too.

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

No branches or pull requests

2 participants