xref: /aosp_15_r20/external/pdfium/public/README (revision 3ac0a46f773bac49fa9476ec2b1cf3f8da5ec3a4)
1*3ac0a46fSAndroid Build Coastguard Workerpublic/ README
2*3ac0a46fSAndroid Build Coastguard Worker
3*3ac0a46fSAndroid Build Coastguard WorkerThe header files in this directory are the only ones that should ever be
4*3ac0a46fSAndroid Build Coastguard Workerincluded by an embedder of PDFium.  If there arises a need for functionality
5*3ac0a46fSAndroid Build Coastguard Workerbeyond what is present here, then a new API must be added here to provide it.
6*3ac0a46fSAndroid Build Coastguard Worker
7*3ac0a46fSAndroid Build Coastguard WorkerDocumentation for the API is within the headers. Start by reading fpdfview.h.
8*3ac0a46fSAndroid Build Coastguard Worker
9*3ac0a46fSAndroid Build Coastguard WorkerThese header files must be entirely contained in this directory; they must
10*3ac0a46fSAndroid Build Coastguard Workernever include other header files from outside of it.
11*3ac0a46fSAndroid Build Coastguard Worker
12*3ac0a46fSAndroid Build Coastguard WorkerThese files must compile cleanly without warnings on both C and C++ compilers.
13*3ac0a46fSAndroid Build Coastguard Worker
14*3ac0a46fSAndroid Build Coastguard WorkerChanges to these files must be carefully considered to avoid breaking
15*3ac0a46fSAndroid Build Coastguard Workercompatibility.
16