Separate the public headers #4

Closed
opened 2026-01-29 20:28:35 +00:00 by claunia · 3 comments
Owner

Originally created by @khaledhosny on GitHub (Oct 17, 2014).

IMO, it would be cleaner to move the public headers to a separate include directory, and/or give them less generic names like brotli-decode.h and brotli-encode.h, to streamline the use of the library.

Originally created by @khaledhosny on GitHub (Oct 17, 2014). IMO, it would be cleaner to move the public headers to a separate `include` directory, and/or give them less generic names like `brotli-decode.h` and `brotli-encode.h`, to streamline the use of the library.
Author
Owner

@khaledhosny commented on GitHub (Oct 17, 2014):

I gave it a quick try, but it seems that the public headers include on most of the other ones, so it will need a bit of thought.

@khaledhosny commented on GitHub (Oct 17, 2014): I gave it a quick try, but it seems that the public headers include on most of the other ones, so it will need a bit of thought.
Author
Owner

@lvandeve commented on GitHub (Sep 21, 2015):

Hi,

Thank you for the comment. For now, if it helps, the headers that can be considered to contain the public API are "decode.h" and its included "streams.h" for the decoder, and "encode.h" and its included "streams.h" for the encoder.

This API is not final, we are in the process of revising it.

@lvandeve commented on GitHub (Sep 21, 2015): Hi, Thank you for the comment. For now, if it helps, the headers that can be considered to contain the public API are "decode.h" and its included "streams.h" for the decoder, and "encode.h" and its included "streams.h" for the encoder. This API is not final, we are in the process of revising it.
Author
Owner

@eustas commented on GitHub (Jun 16, 2016):

Done. enc/encode.h and dec'decode.h now depend only on common/types.h

@eustas commented on GitHub (Jun 16, 2016): Done. enc/encode.h and dec'decode.h now depend only on common/types.h
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/brotli#4