search

puppetlabs / puppet-strings

The next generation Puppet documentation extraction and presentation tool.
http://puppetlabs.github.io/puppet-strings/
Apache License 2.0
90 stars 84 forks source link

Please add support for deprecated tag #339

Closed b4ldr closed 1 year ago

b4ldr commented 1 year ago

Use Case

I recently tried to use the deprecated yard tag hoping that this would create some type of deprecated label on the resulting documentation however as far as i can tell it had no affect. Could we please add support for the deprecated tag.

Describe the Solution You Would Like

When using the @deprecated tag mark functions in the resulting documentation with a deprecated header e.g.

# some function
Puppet::Functions.create_function(:deprecated_function) do
  # @deprecated this function causes issues
 ...
end

should result in something like 

### <a name="deprecated_function"></a>`deprecated_function`

Type: Ruby 4.x API

[DEPRECATD]  this function causes issues

some function
...