[svn.haxx.se] · SVN Dev · SVN Users · SVN Org · TSVN Dev · TSVN Users · Subclipse Dev · Subclipse Users · this month's index

Re: [PATCH] doxygen docs += svn logo

From: Julian Foad <julianfoad_at_btopenworld.com>
Date: Tue, 3 Mar 2015 11:57:26 +0000

Daniel Shahaf wrote:
> Patch to add the project logo to the top-left of generated doxygen
> pages.  Not sure what are the consequences of using a logo larger than
> 200x55 pixels, so won't commit it for now.

+1. Go ahead and commit it. I tried it locally and it looks nice in my version of Firefox and a quick look at the HTML doesn't indicate there will be any problem, and it's hardly a disaster if we have to change or revert it later.

> If adding a file external is a problem, it would be straightforward to
> avoid that by using 'svn cat ^/subversion/site/...' in the 'doc'
> Makefile target; the trade-off is requiring an Internet connection and
> an svn binary to be available.

I can't think of a problem with using the external. If it doesn't work in production, we can change it.

>
> (To test it,

... put the patch in a file; patch up the whitespace to use a tab after the filenames and a space at the beginning of context lines; apply with 'svn patch'; run 'svn update' to fetch the external; and then ...

> run 'make doc', the output will be in ./doc/doxygen/.)

- Julian

> [[[
> doxygen: include the svn logo at the top of generated documentation pages.
>
> * doc/svn-square.jpg:
>     New file.  Alias to site/publish/images/svn-square.jpg, via svn:externals.
>
> * doc/doxygen.conf
>   (PROJECT_LOGO): Set to the square logo (was unset).
> ]]]
>
> [[[
> Index: doc/doxygen.conf
> ===================================================================
> --- doc/doxygen.conf    (revision 1662688)
> +++ doc/doxygen.conf    (working copy)
> @@ -33,6 +33,13 @@ PROJECT_NAME           = Subversion
>
> PROJECT_NUMBER         =
>
> +# 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
> +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
> +# the logo to the output directory.
> +
> +PROJECT_LOGO = doc/svn-square.jpg
> +
> # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
> # base path where the generated documentation will be put.
> # If a relative path is entered, it will be relative to the location
> Index: doc
> ===================================================================
> --- doc    (revision 1661135)
> +++ doc    (working copy)
>
> Property changes on: doc
> ___________________________________________________________________
> Added: svn:externals
> ## -0,0 +1 ##
> +^/subversion/site/publish/images/svn-square.jpg svn-square.jpg
> ]]]
>
Received on 2015-03-03 12:59:21 CET

This is an archived mail posted to the Subversion Dev mailing list.