Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document the policy on internal.h vs. avif.h #1589

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document the policy on internal.h vs. avif.h #1589

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions include/avif/internal.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,18 @@
// Copyright 2019 Joe Drago. All rights reserved.
// SPDX-License-Identifier: BSD-2-Clause

// Policy on including "avif/internal.h" vs. "avif/avif.h"
//
// "avif/avif.h" is the public header of the libavif library. Code that uses
// only the public API of the libavif library should include "avif/avif.h".
//
// "avif/internal.h" is the internal header of the libavif library. Code that
// uses the internal types or functions of the libavif library, such as the
// implementation files src/*.c and the unit tests of internal functions,
// should include "avif/internal.h". A file should not include both
// "avif/internal.h" and "avif/avif.h". An IWYU pragma has been added to tell
// the include-what-you-use tool that "avif/internal.h" exports "avif/avif.h".

#ifndef AVIF_INTERNAL_H
#define AVIF_INTERNAL_H

Expand Down
Loading