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

Message ID 20190702114841.19101-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 2, 2019, 11:48 a.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(-)

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