Document things from EXTERN.h/INTERN.h #23742
Conversation
| # endif | ||
|
|
||
| /* | ||
| =for apidoc Cm||INIT|const_expr |
There was a problem hiding this comment.
Commit Document things in EXTERN.h, INTERN.h
Wondering if this can/should contain an explanation of when one should use this.
(But maybe there is a better place for it?)
Otherwise things run-on
When documenting something like DOINIT which is either #defined or not, it will never have an argument, so automatically include that without the user having to specify it.
For example, the "CV Handling" section in perlintern did not include the introduction for it that appears in perlapi; just the elements. It is more convenient for the reader to have that short summary in this pod as well.
There are lots of empty sections in perlintern, but until this commit it was assumed that all sections would have something in perlapi. This allows the user to specify that particular sections may not have perlapi entries.
khwilliamson
force-pushed
the
EXTERN_api
branch
from
21ee7d4 to
e256897
Compare
|
extensively revised |
| Use them like this: | ||
| #include "perl.h" |
There was a problem hiding this comment.
Can you double check this is correct?
Just looking around I can't immediately see how including perl.h would cause INTERN.h/EXTERN.h to be included..
And looking at some files, av.c for example contains:
#include "EXTERN.h"
#define PERL_IN_AV_C
#include "perl.h"
So it's loading both EXTERN.h and perl.h but if that is the "right" way to do it then I don't see how including onliny perl.h in the example works?
There was a problem hiding this comment.
how about now?
INTERN.h
Outdated
| Use C<EXT> and C<EXTCONST> for variables which will become defined by | ||
| #including F<perl.h>. |
There was a problem hiding this comment.
This also looks a bit conflicting since the example starts with an #include "perl.h" and then uses EXTCONST?
(Should EXT/EXTCONST with INIT ever be used outside of perl.h?)
There was a problem hiding this comment.
how about now?
khwilliamson
force-pushed
the
EXTERN_api
branch
from
e256897 to
7dede11
Compare
And make a few small autodoc.pl improvements that are needed to support this