#1726: Missing POD in .pmc files (and a couple of others)
------------------------------+---------------------------------------------
Reporter: mikehh | Owner: jkeenan
Type: todo | Status: assigned
Priority: normal | Milestone:
Component: coding_standards | Version: trunk
Severity: medium | Keywords:
Lang: | Patch: applied
Platform: |
------------------------------+---------------------------------------------
Comment(by mikehh):
That is all very well, but at present, we at least have a test that
determines if there is documentation related to a given function. Both
c_function_docs.t and pmc_docs.t check to see if there is a header (=item)
for each function and if there is some documentation there.
With these tests we at least can say that there is function documentation.
This helps both the maintainer and the user, even if the user does not
need the static function documentation, the maintainer does.
Unfortunately the test cannot determine the quality of the documentation,
just its existence.
If there are any ideas as to ensuring the existence of documentation in
another way I would be glad to hear them.
Cheers, Michael (mikehh)
--
Ticket URL: <https://trac.parrot.org/parrot/ticket/1726#comment:9>
Parrot <https://trac.parrot.org/parrot/>
Parrot Development
_______________________________________________
parrot-tickets mailing list
[email protected]
http://lists.parrot.org/mailman/listinfo/parrot-tickets
