diff options
author | Chad Versace <chad.versace@linux.intel.com> | 2012-11-15 00:18:43 -0800 |
---|---|---|
committer | Chad Versace <chad.versace@linux.intel.com> | 2012-11-15 00:54:52 -0800 |
commit | 6cf39526db7b028aa201c4cf62bd2253764e20bf (patch) | |
tree | fb7b6455db7a74e8093ffd829a578a54055fd073 /doc | |
parent | d06ea26fe6ed38fb2eade64487052a29a39b36a8 (diff) |
include: Fold nearly all headers into waffle.h
Fold all headers into waffle.h except
- The native platform headers, because users need to be able to select
which to include and exclude.
- waffle_version.h, which is generate at configure time.
When Waffle's documentation consisted of Doxygen in the headers, it was
sensible to maintain a separate header for each class of functions. The
Doxygen was lengthy, thus having separate headers made the documentation
easier to navigate.
Now that the documentation resides in manpage xml, each individual header
is nearly empty. It's silly to have numerous headers that declare only
3 to 4 functions each.
Strictly speaking, removing header files breaks the API. But I'm aware of
no client that will miss the removed headers.
Signed-off-by: Chad Versace <chad.versace@linux.intel.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/code-style.txt | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/code-style.txt b/doc/code-style.txt index 2d12598..1445c75 100644 --- a/doc/code-style.txt +++ b/doc/code-style.txt @@ -29,14 +29,14 @@ Much of Waffle's code adheres to an object oriented design. Not only does this influence Waffle's architectural design, but also its naming conventions and code organization. -For this discussion, we will use `struct waffle_window` as an example. It is +For this discussion, we will use `struct wegl_window` as an example. It is implemented in the files - /include/waffle/waffle_window.h - /src/waffle/api/waffle_window.c + wegl_window.h + wegl_window.c A class's header and source file have the same name as the class. For example, -waffle_window.h and waffle_window.c. +wegl_window.h and wegl_window.c. Method names follow the convention of `typename_operation`. This makes it immediately obvious on what the function acts and in which file the function |