summaryrefslogtreecommitdiff
path: root/autodoc.pl
Commit message (Collapse)AuthorAgeFilesLines
* embed.fnc: Note that 'A' functions not necessarily public APIKarl Williamson2012-12-091-5/+8
| | | | | | | An 'M' in a function entry means that undocumented functions are suppressed from perlapi.pod. Change the comments in embed.fnc to indicate that, and the text in perlapi to warn against using unlisted functions.
* autodoc.pl: pod format fixKarl Williamson2012-03-191-1/+1
|
* Only list non-static undocumented funcs in perlinternFather Chrysostomos2011-08-221-1/+3
|
* Revise perlintern’s descr of undocumented funcsFather Chrysostomos2011-08-221-1/+8
|
* autodoc.pl: output to fit in 79 columnsKarl Williamson2011-08-091-2/+2
|
* Improve wrapping of arguments in perlintern.podFather Chrysostomos2011-07-161-3/+17
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Commit dee6204dc made a huge improvement to the formatting of argument lists in perlapi (except for one pesky little entry, namely caller_cx, that is 81 columns). But I forgot to look through perlintern. This just looks comical: struct refcounted_he * refcounted_he_new_pv(struct refcounted_he *parent, const char *key, U32 hash, SV *value, U32 flags) On an eighty-column terminal that wraps like this: struct refcounted_he * refcounted_he_new_pv(struct refcoun ted_he *parent, const char *k ey, U32 hash, SV *value, U32 flags) Ugh!! So, for entries with individual arguments that don’t fit, this commit wraps them like this: struct refcounted_he * refcounted_he_new_pv( struct refcounted_he *parent, const char *key, U32 hash, SV *value, U32 flags )
* Wrap argument lists in perl{api,intern}.podFather Chrysostomos2011-07-151-7/+29
|
* autodoc.pl: Don't list experimental functions in APIKarl Williamson2011-06-251-1/+2
|
* autodoc.pl: Allow heading level documentationKarl Williamson2010-09-221-2/+54
| | | | | | This patch changes autodoc.pl to accept text that is to come immediately after headings, so that it applies to across the whole section, and not just to an individual function within that section.
* perlpod.api: improve the proseDavid Mitchell2010-08-251-5/+7
| | | | | Tweak the text of the previous commit that describes the status of undocumented functions in the public API.
* autodoc.pl: Clarify use of undocumented fcnsKarl Williamson2010-08-251-10/+21
| | | | | | | | perlapi.pod was changed to list all the undocumented functions. The introductory text was not updated at that time. Now every public API function is at least listed in this pod. Clarify that functions not listed are not public and should not be used, and add a plea for documenting the ones which are missing theirs.
* Teach autodoc.pl about 'o' functions.Ben Morrow2010-07-121-0/+6
| | | | | | | That is, functions with no #define foo Perl_foo. I'm not certain this is the right way to do it, as I don't really understand which flags autodoc honours from which places; currently, it's necessary to put the 'o' flag on the =for apidoc line or it will be ignored.
* [perl #74856] Fix POD syntax in perlapiFather Chrysostomos2010-05-031-1/+1
|
* Use POD-style referencesTom Hukins2010-03-121-2/+2
|
* list undocumented API and internal functions in perlapi.pod and perlintern.podTony Cook2010-03-081-3/+15
| | | | | | | List any functions from embed.fnc that don't have documentation in their own section of perlapi/perlintern as a reminder to either document them, remove them or perhaps flag them as undeserving of documentation.
* Parse embed.fnc first, then cross-check consistency between it and =for apidocNicholas Clark2009-11-201-49/+90
|
* Merge near-duplicate code for 'api' and 'guts'.Nicholas Clark2009-11-201-11/+9
|
* Merge %apidocs and %gutsdocs into $docs{api} and $docs{guts}.Nicholas Clark2009-11-201-8/+7
|
* Correctly check that functions flagged as documented do have documentation.Nicholas Clark2009-11-171-1/+1
|
* Add some documentation to the heads of the various *.pl build scriptsDavid Mitchell2009-05-151-0/+16
|
* Make autodoc.pl accept the root dir in @ARGVMax Maischein2009-04-181-0/+6
|
* As autodoc.pl no longer rebuilds repository files, no need to use regen_lib.plNicholas Clark2009-04-181-57/+23
| | | | | Refactor the duplicated logic for opening, generating and closing files into a single output() subroutine.
* In autodoc.pl, inline and hence eliminate walk_table().Nicholas Clark2009-04-171-49/+39
| | | | | This simplifies the code considerably, as walk_table() was relying on its & prototype to cause the block after it to be co-erced to a passed in subroutine.
* In autodoc.pl, remove the unused parameters and functionality from walk_table().Nicholas Clark2009-04-171-22/+2
| | | | | | It seems that walk_table() was a direct copy from embed.pl back when autodoc.pl was created by commit 94bdecf9800c3bee967274854f7adf2933ffd42b, and the "bonus bits" were never refactored out.
* Subject: PATCH 5.10 documentationSteve Peters2008-12-191-1/+24
| | | | | | From: karl williamson <public@khwilliamson.com> Date: Tue, 16 Dec 2008 16:00:34 -0700 Message-ID: <49483312.80804@khwilliamson.com>
* Drag autodoc.pl and overload.pl into the age of safer_open().Nicholas Clark2008-03-171-24/+20
| | | | | | | | Thanks to the wisdom of london.pm, stuff the filename into the SCALAR slot of the typeglob created in safer_open(), so that ... Add safer_close(), that will die (with the filename) if the close fails. p4raw-id: //depot/perl@33539
* Make autodoc.pl strict clean.Nicholas Clark2007-01-091-4/+5
| | | p4raw-id: //depot/perl@29738
* In vim, modelines are not taken into account if they begin on theRafael Garcia-Suarez2006-10-301-1/+1
| | | | | first character. Also, regenerate perlintern.pod. p4raw-id: //depot/perl@29146
* Modify autodoc.pl to add read-only editor boilerplate for perlapi.podNicholas Clark2006-10-291-0/+26
| | | | | and perlguts.pod p4raw-id: //depot/perl@29138
* Don't warn about lack of docs for functions that appear twice in embed.fnc.Rafael Garcia-Suarez2005-11-141-6/+8
| | | p4raw-id: //depot/perl@26126
* Adding documentation index to perlapi.pod and perlintern.podSébastien Aperghis-Tramoni2005-10-191-1/+4
| | | | | | | | Message-ID: <1129666977.435559a10cb95@imp5-g19.free.fr> (tweaked to remove trailing whitespace to doc entries) Plus, regenerate doc and headers p4raw-id: //depot/perl@25802
* Const Boy II: The LocalizingAndy Lester2005-06-231-1/+1
| | | | | Message-ID: <20050622144059.GA19598@petdance.com> p4raw-id: //depot/perl@24945
* GCC attributes!Andy Lester2005-05-071-0/+1
| | | | | Message-ID: <20050504215540.GA20413@petdance.com> p4raw-id: //depot/perl@24414
* A little more determinacy in our sortingNicholas Clark2005-01-201-1/+2
| | | p4raw-id: //depot/perl@23835
* Protection against trailing spaces in embed.fncRafael Garcia-Suarez2004-11-301-0/+1
| | | p4raw-id: //depot/perl@23568
* Make autodoc.pl write its output with UNIX style EOL's.Steve Hay2004-10-151-0/+3
| | | | | | | This saves the Win32 committer(s?) having to dos2unix the files before committing. Maybe Perforce's "LineEnd: share" suffices anyway, but there's no harm in playing safe. p4raw-id: //depot/perl@23371
* glob('*.c') to find documentation is dangerous when run in uncleanNicholas Clark2004-07-161-2/+10
| | | | | | trees, so isntead use MANIFEST to only scan the legitimate source files. p4raw-id: //depot/perl@23127
* Fix generation of perlapi.podSteve Hay2004-05-311-5/+1
| | | | | Message-ID: <40B71891.6090806@uk.radan.com> p4raw-id: //depot/perl@22875
* build perlapi.pod in deterministic order even when functions differHugo van der Sanden2003-10-021-1/+2
| | | | | only in case; regen perlapi.pod p4raw-id: //depot/perl@21398
* regen_headers tiny tidying:Jarkko Hietaniemi2003-03-081-1/+1
| | | | | | | | | | - regen.pl renamed as regen_lib.pl - regen_headers.pl renamed as regen.pl - added make target 'regen' (kept target 'regen_headers' for porters' brains' backward compatibility) - regen.pl fancified a bit to display the names of the files that got changed by running the scripts p4raw-id: //depot/perl@18851
* regen_headers outside Makefile (was Re: [PATCH] embed.pl doc)Nicholas Clark2002-11-191-6/+12
| | | | | Message-ID: <20021029230003.GF287@Bagpuss.unfortu.net> p4raw-id: //depot/perl@18160
* better handling of whitespace in autodoc declarations; fragment from:Dave Mitchell2002-10-021-11/+15
| | | | | | Subject: [PATCH pad.c,h] move all pad-related code to its own src file Message-ID: <20020925234023.A20044@fdgroup.com> p4raw-id: //depot/perl@17952
* PATCH: correct confusing lie in {embed,autodoc}.plRobin Houston2002-06-161-1/+1
| | | | | Message-Id: <20020616233350.A9675@robin.kitsite.com> p4raw-id: //depot/perl@17261
* OS/2 buildIlya Zakharevich2002-02-111-0/+3
| | | | | | | Message-ID: <20020211065640.A14993@math.ohio-state.edu> (sans the Configure, perlio.sym, and t/op/stat.t parts) p4raw-id: //depot/perl@14641
* Simon's new perlapi scheme, I hope I got all the pieces.Jarkko Hietaniemi2002-01-021-0/+274
p4raw-id: //depot/perl@14029
View Lorry Controller Status