diff options
| author | Karl Williamson <public@khwilliamson.com> | 2012-12-02 22:14:07 -0700 |
|---|---|---|
| committer | Karl Williamson <public@khwilliamson.com> | 2012-12-09 10:27:18 -0700 |
| commit | ba4591a5abe7e0d129a8a810764a6e21278c8604 (patch) | |
| tree | f830ea8aac4bd8ab5ab5cf29cee78a93f09baa73 /autodoc.pl | |
| parent | bf3cd0e64298155c8984b0fce2cce3b4648d3110 (diff) | |
| download | perl-ba4591a5abe7e0d129a8a810764a6e21278c8604.tar.gz | |
embed.fnc: Note that 'A' functions not necessarily public API
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.
Diffstat (limited to 'autodoc.pl')
| -rw-r--r-- | autodoc.pl | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/autodoc.pl b/autodoc.pl index 3734884789..3b39696af5 100644 --- a/autodoc.pl +++ b/autodoc.pl @@ -274,11 +274,14 @@ _EOH_ print $fh $podname eq 'perlapi' ? <<'_EOB_' : <<'_EOB_'; The following functions have been flagged as part of the public API, but are currently undocumented. Use them at your own risk, as the -interfaces are subject to change. - -If you use one of them, you may wish to consider creating and submitting -documentation for it. If your patch is accepted, this will indicate that -the interface is stable (unless it is explicitly marked otherwise). +interfaces are subject to change. Functions that are not listed in this +document are not intended for public use, and should NOT be used under any +circumstances. + +If you use one of the undocumented functions below, you may wish to consider +creating and submitting documentation for it. If your patch is accepted, this +will indicate that the interface is stable (unless it is explicitly marked +otherwise). =over |