diff options
| author | Tom Sepez <tsepez@chromium.org> | 2015-05-12 15:44:39 -0700 |
|---|---|---|
| committer | Tom Sepez <tsepez@chromium.org> | 2015-05-12 15:44:39 -0700 |
| commit | e6bd866c5c64950a8b2836e7254e1f44b2fe0925 (patch) | |
| tree | 00430833ce5262a8795ba4890ac28fe9e6ce41c0 | |
| parent | feb10c58777949ea3d300b7554204edde422d1f2 (diff) | |
| download | pdfium-e6bd866c5c64950a8b2836e7254e1f44b2fe0925.tar.xz | |
Describe required properties of public/ files with a README.
R=thestig@chromium.org
Review URL: https://codereview.chromium.org/1140833002
| -rw-r--r-- | public/README | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/public/README b/public/README new file mode 100644 index 0000000000..b07d0f3068 --- /dev/null +++ b/public/README @@ -0,0 +1,13 @@ +public/ README + +The header files in this directory are the only ones that should ever be +included by an embedder of PDFium. If there arises a need for functionality +beyond what is present here, then a new API must be added here to provide it. + +These header files must be entirely contained in this directory; they must +never include other header files from outside of it. + +These files must compile cleanly without warnings on both C and C++ compilers. + +Changes to these files must be carefully considered to avoid breaking +compatibility. |