COIN-OR::LEMON - Graph Library

Opened 9 years ago

Closed 9 years ago

Last modified 9 years ago

#404 closed enhancement (done)

Update the configuration files for Doxygen 1.7.3

Reported by: Peter Kovacs Owned by: Peter Kovacs
Priority: major Milestone: LEMON 1.3 release
Component: documentation Version: hg main
Keywords: Cc:
Revision id:

Description


Attachments (2)

404-c48431d887e3.patch (6.6 KB) - added by Peter Kovacs 9 years ago.
404-f53a7730501e.patch (6.6 KB) - added by Peter Kovacs 9 years ago.

Download all attachments as: .zip

Change History (15)

Changed 9 years ago by Peter Kovacs

Attachment: 404-c48431d887e3.patch added

comment:1 Changed 9 years ago by Peter Kovacs

Status: newassigned

[c48431d887e3] contains the updated files.

comment:2 Changed 9 years ago by Peter Kovacs

Note that Doxygen 1.7.3 creates a top header for the doc pages on which the project name, project version and an optional project brief text is displayed. I set this brief text to "An open source C++ graph library", but it can be modified.

comment:3 Changed 9 years ago by Alpar Juttner

Won't these changes prohibit using earlier versions of Doxygen?

comment:4 Changed 9 years ago by Peter Kovacs

I don't think so, because only new key-value pairs are added and nothing is removed. Previous updates did not cause such problems.

comment:5 Changed 9 years ago by Peter Kovacs

... but I'm not completely sure.

comment:6 in reply to:  2 Changed 9 years ago by Alpar Juttner

Replying to kpeter:

Note that Doxygen 1.7.3 creates a top header for the doc pages on which the project name, project version and an optional project brief text is displayed. I set this brief text to "An open source C++ graph library", but it can be modified.

Doxygen 1.7.3 introduces the header containing the project name and version on the top of each page. This is

  • Ugly (a combination of a HUGE and a Big font size, in front of a background inconsistent with the other parts of the page.
  • Uncomfortable (is reduces the useful part of the screen)
  • Completely unnecessary.

This brief text (and perhaps the logo, which could also be added) adds one more line to the div, though it is at least more reasonably sized.

So, I would go into the other direction and remove this header completely if possible.

comment:7 Changed 9 years ago by Alpar Juttner

You also removed this:

#--------------------------------------------------------------------------- 
# Configuration::additions related to the search engine    
#--------------------------------------------------------------------------- 
SEARCHENGINE           = NO

Instead, I have just tried to use

SEARCHENGINE           = YES

and this works perfectly, even when you open the generated files locally in your browser. (It puts a search box into the top right corner). I think it is a really useful feature so I suggest turning it on.

comment:8 Changed 9 years ago by Alpar Juttner

Btw. the doc generation has been customizable since [481496e6d71f]. Currently only one doxygen option (SOURCE_BROWSER) is exported to cmake, but we may consider adding more.

comment:9 Changed 9 years ago by Peter Kovacs

I'm not against removing this new header, but note that it is the only place where the project version number is displayed. (Previous versions of Doxygen put it to the main page.)

Anyway, I did not find an option to remove this header, which is quite annoying. However, we could hide it by modifying the CSS stlye sheets.

comment:10 in reply to:  7 Changed 9 years ago by Peter Kovacs

Replying to alpar:

You also removed this:
SEARCHENGINE = NO

It was not removed, just moved to another group (according to the latest template file).

Instead, I have just tried to use
SEARCHENGINE = YES
and this works perfectly, even when you open the generated files locally in your browser. (It puts a search box into the top right corner). I think it is a really useful feature so I suggest turning it on.

I agree.

Changed 9 years ago by Peter Kovacs

Attachment: 404-f53a7730501e.patch added

comment:11 Changed 9 years ago by Peter Kovacs

I attached another patch [f53a7730501e], which does not contain project brief text and enables the search system.

comment:12 Changed 9 years ago by Alpar Juttner

Resolution: done
Status: assignedclosed

I rebased your patch as [021e232acda2] and put [d3b041452dd8] on top of is. This latter patch hides the standard Doxygen header completely, but adds the version string to the title of the main doc page.

These two changesets are merged into branches 1.1, 1.2 and main.

comment:13 Changed 9 years ago by Peter Kovacs

I like this solution. Thanks.

Note: See TracTickets for help on using tickets.