From e6bd866c5c64950a8b2836e7254e1f44b2fe0925 Mon Sep 17 00:00:00 2001 From: Tom Sepez Date: Tue, 12 May 2015 15:44:39 -0700 Subject: Describe required properties of public/ files with a README. R=thestig@chromium.org Review URL: https://codereview.chromium.org/1140833002 --- public/README | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 public/README (limited to 'public') 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. -- cgit v1.2.3