[libcamera-devel,1/4] Documentation: Make the project brief more expressive

Message ID 20190704130347.9372-1-kieran.bingham@ideasonboard.com
State Accepted
Headers show
Series
  • [libcamera-devel,1/4] Documentation: Make the project brief more expressive
Related show

Commit Message

Kieran Bingham July 4, 2019, 1:03 p.m. UTC
The current project brief lacks any quotation marks, and causes the
Doxygen API documents to show the header "libcameraframework".

Replace the simplistic definition with a better brief, and ensure
quotation marks are provided to maintain spacing.

Fixes: 53c4d4c34fc4 ("Documentation: Generate source code documentation using Doxygen")
Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
---
 Documentation/Doxyfile.in | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Kieran Bingham July 4, 2019, 1:03 p.m. UTC | #1
Hi all,

V2 of my small misc branch to add automatic version generation to our meson
infrastructure, and incorporate that information into the documentation and
utilities.

While modifying qcam, I've also extended qcam to provide an average frame
rate over a 2 second window. This is generated using a QTimer so that we
can still update the rate in the event of no frames being generated from
libcamera.


Kieran Bingham (5):
  Documentation: Make the project brief more expressive
  libcamera: Auto generate version information
  qcam: Move static timestamp to MainWindow
  qcam: Add the version string to the title
  qcam: Update window title with FPS

 Documentation/Doxyfile.in        |  2 +-
 Documentation/conf.py            |  7 ++----
 Documentation/meson.build        |  6 ++++--
 include/libcamera/meson.build    |  5 +++++
 include/libcamera/version.h.in   | 22 +++++++++++++++++++
 meson.build                      |  9 +++-----
 src/libcamera/camera_manager.cpp |  8 +++++++
 src/libcamera/meson.build        |  1 +
 src/qcam/main_window.cpp         | 36 ++++++++++++++++++++++++++-----
 src/qcam/main_window.h           | 14 ++++++++++++
 src/qcam/meson.build             | 11 +++++++++-
 utils/gen-version.sh             | 37 ++++++++++++++++++++++++++++++++
 12 files changed, 138 insertions(+), 20 deletions(-)
 create mode 100644 include/libcamera/version.h.in
 create mode 100755 utils/gen-version.sh

Patch

diff --git a/Documentation/Doxyfile.in b/Documentation/Doxyfile.in
index c58631200dd5..0dc1ab3944d1 100644
--- a/Documentation/Doxyfile.in
+++ b/Documentation/Doxyfile.in
@@ -44,7 +44,7 @@  PROJECT_NUMBER         = @VERSION@
 # for a project that appears at the top of each page and should give viewer a
 # quick idea about the purpose of the project. Keep the description short.
 
-PROJECT_BRIEF          = libcamera framework
+PROJECT_BRIEF          = "Supporting complex camera pipelines and devices"
 
 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
 # in the documentation. The maximum height of the logo should not exceed 55