Closed GoogleCodeExporter closed 9 years ago
The documentation (due to a technical limitation in the script that generates
it) is somewhat misleading in that it states that the type/value of the
parameter "download" is unspecified but the feature should nevertheless be
fully operational. sigplus retrieves access level strings directly from the
Joomla database. Both (existing) numeric values as well as strings such as
"Public", "Registered" or "Special" should work.
Original comment by huny...@gmail.com
on 17 Aug 2012 at 8:03
Thank you for your reply. On this occasion. I miss those descriptions one
example of the use of the described parameter. In tenspsub would always clear.
Regards!
Original comment by ten.mari...@gmail.com
on 17 Aug 2012 at 8:18
I completely agree with you that insightful examples are a definitive must for
more complex options like download access. Unfortunately, the documentation
generator script in its current state can combine the parameter name, the
back-end full name and the parameter summary and some type information (though
by far not all) but not examples. If I would add an example manually, it would
be overwritten the next time the documentation is re-generated from source.
Even if tempting from a quality perspective, maintaining the documentation of
configuration settings by hand is not an option given the little time I have
that I can devote to the project.
Original comment by huny...@gmail.com
on 17 Aug 2012 at 10:55
I understand, thank you for the explanation.
Original comment by venapr...@gmail.com
on 18 Aug 2012 at 7:28
Changed issue title to reflect that it is about adding more information
(including examples) to the documentation and not a defect in the software.
Original comment by huny...@gmail.com
on 21 Oct 2012 at 4:57
The documentation generator tool has been updated to support plug-in activation
code examples. The documentation for back-end configuration settings has been
re-generated. The wiki page no longer displays parameter types as "unspecified"
and where appropriate, examples are shown.
Original comment by huny...@gmail.com
on 31 Oct 2012 at 3:11
Thanks!
Original comment by ten.mari...@gmail.com
on 2 Nov 2012 at 8:03
Original issue reported on code.google.com by
ten.mari...@gmail.com
on 27 Jul 2012 at 1:07Attachments: