Ticket #4360 (closed: fixed)

Opened 9 years ago

Last modified 5 years ago

Add a documentation target to CMake

Reported by: Martyn Gigg Owned by: Peter Peterson
Priority: major Milestone: Release 2.0
Component: Mantid Keywords:
Cc: Blocked By:
Blocking: Tester: Stuart Campbell

Description

We currently have far too many doxygen config files. We should have a single template and have CMake produce an appropriate config file along with a documentation target so that someone can type 'make documentation'

Change History

comment:1 Changed 9 years ago by Peter Peterson

  • Owner set to Peter Peterson
  • Status changed from new to accepted

comment:2 Changed 9 years ago by Peter Peterson

Look for doxygen. Refs #4360.

Changeset: 72f3b900ccbf07c0ece642563e98e12fb7b00121

comment:3 Changed 9 years ago by Peter Peterson

First pass at doxygen target. Refs #4360.

Changeset: 5657cbfe42098140ae3524d6c075322196722d25

comment:4 Changed 9 years ago by Peter Peterson

Autodetect doxygen options. Refs #4360.

Changeset: e859c955682ea6f246c970e6913c812ace11a13e

comment:5 Changed 9 years ago by Peter Peterson

Autodetect doxygen options. Refs #4360.

Changeset: 963881bebed4d3d7f47fd13b05415ce5a54c3c49

comment:6 Changed 9 years ago by Peter Peterson

Cleaning up and adding directories. Refs #4360.

Changeset: 0e76a52c1e2dca323978ccc6392c383b251fc309

comment:7 Changed 9 years ago by Peter Peterson

Adding usage comment. Refs #4360.

Changeset: 725afcd047de466f23d0561f63a035312d6ae37c

comment:8 Changed 9 years ago by Peter Peterson

Messing with included sources. Refs #4360.

Changeset: 32f7f2a5a69b5330f5122dc9c67de3f8c92b62ec

comment:9 follow-up: ↓ 18 Changed 9 years ago by Nick Draper

A bit of historical information:

Previously we had 3:

  1. Warnings formatted to work with Visual Studio so warnings could be displayed in the warnings list and clicked to locate
  2. As 1 but for eclipse
  3. Set to output all of the files for the website including slow stuff lie the dot diagrams

I'm not saying we have to keep all of the files but we don't want to loose the ability to work nicely with all of the IDE's we use.

comment:10 Changed 9 years ago by Martyn Gigg

I think we can still keep all of this with CMake and a template. CMake knows what generator, i.e. Eclipse, Visual Studio, you are trying to use and we could just have another cmake options for other doxygen related options.

comment:11 Changed 9 years ago by Peter Peterson

Fixing continue line characters. Refs #4360.

Changeset: 023ea453b210b46724e06e71fe10281a9d235721

comment:12 Changed 9 years ago by Peter Peterson

Copying image for index page into website. Refs #4360.

Changeset: 801c483e32afc8cdddd873c8891af27d8f707d0a

comment:13 Changed 9 years ago by Peter Peterson

Deleting dead line. Refs #4360.

Changeset: a9c56ad70c93c68cb2073d5df5dc4daf327dfad8

comment:14 Changed 9 years ago by Peter Peterson

Changed to relative path for main image. Refs #4360.

Changeset: 87a7e00e2b682af791972d96e7d86b675d567ab6

comment:15 Changed 9 years ago by Peter Peterson

Deleting unwanted doxygen configuration files. Refs #4360.

Changeset: 36d4f98257fd8af18a0ac4709c871a8b8a9aa14e

comment:16 Changed 9 years ago by Peter Peterson

Deleting commented code. Refs #4360.

Changeset: 71a7f10ee95a5b8657dd75dbb3d5b07310723791

comment:17 Changed 9 years ago by Peter Peterson

Removing last duplicate doxyfile. Refs #4360.

Changeset: a90a2a302faa7a115eac810bccc9c5a2cc3b067c

comment:18 in reply to: ↑ 9 Changed 9 years ago by Peter Peterson

Currently dot usage is turned off by default, but can be turned on with "USE_DOT". The template is moderately dynamic on what it does/doesn't do. It was put together by examining diffs of all five doxygen configurations. Where they where identical, I just copied the configuration in. Many of the differences were just between default values of a configuration copied from elsewhere.

Replying to Nick Draper:

A bit of historical information:

Previously we had 3:

  1. Warnings formatted to work with Visual Studio so warnings could be displayed in the warnings list and clicked to locate
  2. As 1 but for eclipse
  3. Set to output all of the files for the website including slow stuff lie the dot diagrams

I'm not saying we have to keep all of the files but we don't want to loose the ability to work nicely with all of the IDE's we use.

comment:19 Changed 9 years ago by Peter Peterson

  • Status changed from accepted to verify
  • Resolution set to fixed

After a quick look over the other available doxygen options, the only relevant one left is for eclipse. This is being left until somebody asks for it and the ticket is being closed as complete.

comment:20 Changed 9 years ago by Stuart Campbell

  • Status changed from verify to verifying
  • Tester set to Stuart Campbell

comment:21 Changed 9 years ago by Stuart Campbell

  • Status changed from verifying to closed

make doxygen does indeed work and produce documentation!

comment:22 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue 5207

Note: See TracTickets for help on using tickets.