Adds the @deprecated_method, @deprecated_argument, and
@deprecated_response_field tags for API documentation. Also adds the
'deprecated', 'deprecation_notice', 'deprecation_effective', and
'deprecation_description' attributes for the API models and their
properties.
closes GRADE-1450
Test Plan:
1. Read the deprecation_README provided in this commit and verify you
can deprecate methods, arguments, response fields, models, and
model attributes. This verificiation process should include:
- Verifying the `rake doc:api` command throws an error when invalid
and/or missing parameters are used for the deprecation tags
- Verifying the deprecations show up in the generated documentation
(located at public/doc/api/index.html) after running
`rake doc:api`.
2. Verify the @argument, @response_field, and @model tags still work
and generate appropriate documentation when running `rake doc:api`
Change-Id: If6c2b0ee9fccbbd202990d8835c6266017e2dfa5
Reviewed-on: https://gerrit.instructure.com/138581
Reviewed-by: Gary Mei <gmei@instructure.com>
Reviewed-by: Derek Bender <djbender@instructure.com>
QA-Review: Gary Mei <gmei@instructure.com>
Tested-by: Jenkins
Product-Review: Simon Williams <simon@instructure.com>
3792afc12e