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

Message ID 20190704145942.17879-2-kieran.bingham@ideasonboard.com
State Accepted
Headers show
Series
  • Automatic Version Generation ++
Related show

Commit Message

Kieran Bingham July 4, 2019, 2:59 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

Laurent Pinchart July 4, 2019, 9:04 p.m. UTC | #1
Hi Kieran,

Thank you for the patch.

On Thu, Jul 04, 2019 at 03:59:37PM +0100, Kieran Bingham wrote:
> 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>

I'm sure we'll bikeshed this more, but for now,

Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

> ---
>  Documentation/Doxyfile.in | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/Doxyfile.in b/Documentation/Doxyfile.in
> index 9ca32241b895..cad85ff979f8 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 cameras in Linux since 2019"
>  
>  # 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

Patch

diff --git a/Documentation/Doxyfile.in b/Documentation/Doxyfile.in
index 9ca32241b895..cad85ff979f8 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 cameras in Linux since 2019"
 
 # 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