summaryrefslogtreecommitdiff
path: root/autodoc.pl
Commit message (Collapse)AuthorAgeFilesLines
* autodoc.pl: 'G' is a legitimate embed.fnc flagKarl Williamson2021-04-141-1/+1
|
* autodoc.pl: Adjust max permissible line lengthKarl Williamson2020-12-141-3/+3
| | | | perldoc takes up 4 column indent, not 7.
* Account for 'less' reserving an extra columnKarl Williamson2020-11-301-2/+2
| | | | | | | | | | | | | | | | | | | | After decades of stability, the 'less' pager project decided to claim an extra column for its own use when called with certain common options. This commit changes some of the auto-generating tools to wrap one column earlier to compensate, and changes podcheck to also whine on wide verbatim text one column less. But it changes the podcheck data base to grandfather-in all the many existing places that exceed that amount. That means only changes made to pods after this commit will be held to the stricter value. Of course, what this means is those pods will wrap or truncate in these places on an 80 column window, making them harder to read, when used with 'less' and when it is called with the options that reserve those two columns. Patches welcome. I haven't seen the wrapping problem with perldoc, and haven't investigated much.
* perlapi: Remove per-thread section; move to real scnsKarl Williamson2020-11-251-2/+0
| | | | | Instead of having a grab bag section of all interpreter variables, move their documentation to the section that they actually fit under.
* perlapi/perlintern: Better sort the SEE ALSO scnKarl Williamson2020-11-071-4/+7
|
* perlapi: Split section Display and DumpKarl Williamson2020-11-061-3/+5
| | | | into Debugging and Display sections
* autodoc.pl: A hash needs to have no keys to be emptyKarl Williamson2020-11-061-2/+1
|
* autodoc.pl: Specify scn for single-purpose filesKarl Williamson2020-11-061-4/+60
| | | | | | | | Many of the files in perl are for one thing only, and hence their embedded documentation will be for that one thing. By creating a hash here of them, those files don't have to worry about what section that documentation goes under, and so it can be completely changed without affecting them.
* Revert and fix "autodoc.pl: Don't recalculate value"Karl Williamson2020-11-061-3/+7
| | | | | | | | This reverts commit 0213d97dcda976f02ce257031d969e7964ecc545, and fixes it up. That commit failed to account for that there were extra components needed in the calculation
* autodoc.pl: Enhance apidoc_section featureKarl Williamson2020-11-061-8/+19
| | | | | | | | | | | This feature allows documentation destined for perlapi or perlintern to be split into sections of related functions, no matter where the documentation source is. Prior to this commit the line had to contain the exact text of the title of the section. Now it can be a $variable name that autodoc.pl expands to the title. It still has to be an exact match for the variable in autodoc, but now, the expanded text can be changed in autodoc alone, without other files needing to be updated at the same time.
* perlapi: Add a link at the beginning to the UndocumentedsKarl Williamson2020-11-051-3/+8
|
* autodoc.pl: Rename a few variables for consistencyKarl Williamson2020-11-051-9/+9
|
* autodoc.pl: Extract code into a fcnKarl Williamson2020-11-051-18/+29
| | | | This is in preparation for it to be called from a 2nd place
* autodoc.pl: Don't recalculate valueKarl Williamson2020-11-051-7/+3
| | | | | e4f5ddf407394c177acefd200a338654dccca2e4 moved this calculation, but I forgot to remove this portion of it.
* autodoc.pl: White-space, comments onlyKarl Williamson2020-11-051-3/+5
|
* perlapi: Move some formats to the Formatting scnKarl Williamson2020-11-051-0/+5
| | | | These were going into wrong ones.
* autodoc: Add clarifying info to error messagesKarl Williamson2020-10-221-4/+5
|
* autodoc.pl: Use $scalars to hold heading namesKarl Williamson2020-10-221-82/+141
| | | | | | Prior to this, the headings were kept as string keys in a hash. This allows for easier tweaking of their contents, and to more easily catch typos.
* autodoc.pl: Output undocumented fcns in multi columnsKarl Williamson2020-10-221-3/+118
| | | | | This is just a list, with nothing to be gained by having a single entry per line, and making multiple columns shortens it significantly.
* autodoc.pl: Extract code into a functionKarl Williamson2020-10-221-33/+3
| | | | This is in preparation of it becoming more complex in a future commit
* autodoc.pl: Rename sort function for clarity of purposeKarl Williamson2020-10-221-8/+56
|
* autodoc: Add ability to specify typedefsKarl Williamson2020-10-081-7/+13
| | | | | Typedefs are part of the API; this allows us to document basic things such as CV, U8 that aren't currently covered.
* autodoc: Avoid a loop iterationKarl Williamson2020-09-051-3/+4
| | | | | | Initializing everything with the first elements values allows us to not look at that element again. Previously, only somethings were so initialized.
* autodoc: Properly take into account pTHXKarl Williamson2020-09-051-6/+9
| | | | | | Before this patch, it wasn't considering the thread context when deciding whether two forms of similar functions had the same signature or not; hence not displaying things when it should have.
* autodoc: Correctly display some function signaturesKarl Williamson2020-09-051-15/+42
| | | | | | The code wasn't properly showing signatures when the function was a subsidiary one in an entry containing multiple functions, and the function's signature was specified in embed.fnc
* autodoc: Fix for win32.Karl Williamson2020-09-051-1/+4
| | | | | | This platform has config.h located in a different place Thanks to Christian Walde for testing this
* autodoc: Update comments to reflect new behaviorKarl Williamson2020-09-041-11/+41
|
* autodoc.pl: Regularize perlintern handlingKarl Williamson2020-09-041-15/+24
|
* autodoc.pl: Add missing semi-colonKarl Williamson2020-09-041-1/+1
|
* autodoc: Add section name checkingKarl Williamson2020-09-041-24/+128
| | | | | | | In the past a section could just spring into existence. This adds a check that it is one of the known ones, so typos won't create a screwed up perlapi. If a new section is needed, just add it to the list of valid ones.
* autodoc: Display list of sections near topKarl Williamson2020-09-041-0/+10
| | | | This would enable someone to more quickly organize their search
* autodoc: Don't output empty sectionKarl Williamson2020-09-041-1/+7
| | | | But warn when one encountered.
* autodoc: Revise display of apidoc elementsKarl Williamson2020-09-041-83/+218
| | | | | | | | | | | | This heavily refactors the code that outputs each api element. Indentation is cut to 1 space, as anything more doesn't matter much visually, or at all in html displays, and this gives more geography on a line. More importantly, multiple items sharing the same pod within the same element are displayed prettier. xxx 1 indent f display
* autodoc: Add config.h to what is documentedKarl Williamson2020-09-041-5/+582
| | | | config.h is now parsed, and the results intermixed into perlapi.
* autodoc: Add section footers in this fileKarl Williamson2020-09-041-0/+3
| | | | | | | Previously, there were no section footers This commit doesn't actually add any of these; just accepts and handles any future ones.
* autodo: Enclose elements with C<...>Karl Williamson2020-09-041-1/+1
| | | | This make all-caps ones look better
* autodoc: Add ability to list variants like perlfunc doesKarl Williamson2020-09-041-6/+46
| | | | | | | | | | | | This adds apidoc_item so that you can specify things that are closely related in a single entry, with the list of the things at the top, much as perlfunc does with, say, various forms of split The arguments to the non-main entry are accepted but nothing is done with them now. This is because I was uncertain how we might want to display things, as the arguments to the main entry have been shown forever only in the usage paragraph at the end, unlike perlfunc where the arguments are displayed on the same line as each variant.
* autodoc: Simplify input loopsKarl Williamson2020-09-041-165/+180
| | | | | | | | | This refactors the code that reads the documentation to eliminate redundant code. Now, the same loop reads both the heading text and the pod guts. As part of this, certain headings that were inadvertently omitted from perlapi are now included.
* autodoc: Use hash not array for heterogenous elementsKarl Williamson2020-09-041-3/+12
|
* autodoc.pl: Use bold font for 'deprecated', 'experimental'Karl Williamson2020-09-041-3/+3
|
* autodoc.pl: Change more misleading variable namesKarl Williamson2020-09-041-32/+31
| | | | And shortens others
* autodoc.pl: Rmv unnecessary variableKarl Williamson2020-09-041-22/+20
| | | | | | | This intermediate value caused confusion, and isn't necessary. A porting test would fail temporarily, so that has been turned off for the next few commits
* autodoc.pl: Change some variable namesKarl Williamson2020-09-041-51/+51
| | | | The previous ones were misleading
* autodoc: Warn on empty podKarl Williamson2020-09-041-0/+2
|
* autodoc.pl: White space onlyKarl Williamson2020-09-041-82/+81
| | | | Outdent since the previous commit removed an enclosing block
* autodoc.pl: Extract code into a functionKarl Williamson2020-09-041-24/+45
| | | | | | This is in preparation for it being called from a second place. The function is also expanded to accept a future syntactic construct
* autodoc: Don't output empty sectionsKarl Williamson2020-09-041-0/+2
|
* autodoc.pl: Use consistent sort for missing docsKarl Williamson2020-09-041-1/+1
| | | | | The rest of the file is basically dictionary order; do the same for these
* autodoc.pl: Improve the SEE ALSO sectionKarl Williamson2020-09-041-29/+17
| | | | | This harvests all the pods linked to by perlapi/perlintern and puts them in the SEE ALSO section
* autodoc.pl: Add ability to link to other podsKarl Williamson2020-09-041-33/+66
| | | | | | | | This enhances perlapi and perlintern so that an API element that is documented in some other pod can automatically have a link to that pod generated and placed into perlapi/perlintern. This allows one stop browsing through the API, as the hither-to-unlisted elements now are listed there, with a link.
View Lorry Controller Status