How do I get the YARD rendered from another file?
# name: foo
# desc: blub
# auth: me
# two blank lines in front of docstring+class for YARD
# {include:file:yrd/init.yrd}
class foo (
String $bar = undef,
) {
[…]
}
# EOF
And `init.yrd` looks like this:
# name: foo YARD documentation
# auth: me
@param bar does cool stuff
@example some badass example
'Lalalala'
# EOF
Doing a `puppet strings generate manifests/init.pp` generates the documentation, but the included file is included verbatim. The `@param` reference and everything still stays there. If I'd copy the whole documentation into `init.pp`, too, the YARD-tags are recognized, but I want the class documentation to go separately. I hardly want 800 lines of documentation in front of my 400 line class. It's already big enough!
↧