docs: Add deprecated attribute

This commit is contained in:
Brendan Hagan 2017-10-25 11:59:14 -05:00
parent c2937d7857
commit c516c89c97
2 changed files with 12 additions and 1 deletions

View File

@ -422,6 +422,7 @@ void WSRequestHandler::HandleGetSceneList(WSRequestHandler* req) {
* @name SetSourceRender
* @category sources
* @since 0.3
* @deprecated Since unreleased. Prefer the use of SetSceneItemProperties.
*/
void WSRequestHandler::HandleSetSceneItemRender(WSRequestHandler* req) {
if (!req->hasField("source") ||
@ -1190,6 +1191,7 @@ void WSRequestHandler::HandleGetSyncOffset(WSRequestHandler* req) {
* @name SetSceneItemPosition
* @category sources
* @since 4.0.0
* @deprecated Since unreleased. Prefer the use of SetSceneItemProperties.
*/
void WSRequestHandler::HandleSetSceneItemPosition(WSRequestHandler* req) {
if (!req->hasField("item") ||
@ -1241,6 +1243,7 @@ void WSRequestHandler::HandleSetSceneItemPosition(WSRequestHandler* req) {
* @name SetSceneItemTransform
* @category sources
* @since 4.0.0
* @deprecated Since unreleased. Prefer the use of SetSceneItemProperties.
*/
void WSRequestHandler::HandleSetSceneItemTransform(WSRequestHandler* req) {
if (!req->hasField("item") ||
@ -1297,6 +1300,7 @@ void WSRequestHandler::HandleSetSceneItemTransform(WSRequestHandler* req) {
* @name SetSceneItemCrop
* @category sources
* @since 4.1.0
* @deprecated Since unreleased. Prefer the use of SetSceneItemProperties.
*/
void WSRequestHandler::HandleSetSceneItemCrop(WSRequestHandler* req) {
if (!req->hasField("item")) {

View File

@ -15,6 +15,10 @@
{{#each this}}
### {{name}}
{{#if deprecated}}
- **⚠️ Deprecated. {{deprecated}} ⚠️**
{{/if}}
{{#eq since "unreleased"}}
- Unreleased
{{else}}
@ -51,6 +55,10 @@ _No additional response items._
{{#each this}}
### {{name}}
{{#if deprecated}}
- **⚠️ Deprecated. {{deprecated}} ⚠️**
{{/if}}
{{#eq since "unreleased"}}
- Unreleased
{{else}}
@ -89,4 +97,3 @@ _No additional response items._
{{/each}}
{{/each}}