pdfium/public/README
Tom Sepez a5938d82d7 Add a sentence to public/README about where to start
Change-Id: I21e8724493eaa5e1ae766245bebdca3118e9187d
Reviewed-on: https://pdfium-review.googlesource.com/c/pdfium/+/93410
Auto-Submit: Tom Sepez <tsepez@chromium.org>
Reviewed-by: Lei Zhang <thestig@chromium.org>
Commit-Queue: Lei Zhang <thestig@chromium.org>
2022-05-05 21:25:02 +00:00

16 lines
618 B
Plaintext

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.
Documentation for the API is within the headers. Start by reading fpdfview.h.
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.