From 170fef3082dc36d8f9a1d995e27fb309c50ed3d5 Mon Sep 17 00:00:00 2001 From: kanschat Date: Fri, 21 Sep 2012 08:15:35 +0000 Subject: [PATCH] explain how to link documentation git-svn-id: https://svn.dealii.org/trunk@26582 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/doc/development/doxygen.html | 58 ++++++++++++++++++++++++++++ deal.II/doc/development/navbar.html | 3 +- deal.II/doc/development/toc.html | 9 ++++- deal.II/doc/doxygen/headers/main.h | 16 +++++++- 4 files changed, 83 insertions(+), 3 deletions(-) create mode 100644 deal.II/doc/development/doxygen.html diff --git a/deal.II/doc/development/doxygen.html b/deal.II/doc/development/doxygen.html new file mode 100644 index 0000000000..c1a30cca20 --- /dev/null +++ b/deal.II/doc/development/doxygen.html @@ -0,0 +1,58 @@ + + + + + deal.II Doxygen documentation + + + + + + + + + +

Referencing the deal.II online documentation from your project

+ +

deal.II has an extensive reference documentation generated + by Doxygen. One of the many + features of Doxygen is, that all class names, function noames and so + on are cross-linked in the documentation, and a single click + suffices to jump to the documentation of an object.

+ +

When you write online documentation for your own code, it might + come pretty handy if you could provide links directly into the + deal.II documentation. And indeed, you can. Here is how: + +

Download the tag file for Doxygen. As of now, the link to the + tag file can be found on the main documentation page generated by + Doxygen, if the online documentation is available, + here. For older revisions, + links are provided here by revision number: + 7.2.0, + 7.1.0, + 7.0.0. +
Once your deal.tag file is in a location where + Doxygen can find it, add the following linbe to your Doxygen + configuration file: +
```
+
+TAGFILES = deal.tag=http://www.dealii.org/X.Y.Z/doxygen/deal.II
+
+
```
+ where X.Y.Z refers to the release number for which + you downloaded the tag file. +

+ +

+ The deal.II Group

+ + + + diff --git a/deal.II/doc/development/navbar.html b/deal.II/doc/development/navbar.html index 0bb28b059e..08115b6d52 100644 --- a/deal.II/doc/development/navbar.html +++ b/deal.II/doc/development/navbar.html @@ -5,7 +5,7 @@ deal.II Development Navigation Bar - + @@ -28,6 +28,7 @@ target="body">Documentation
Porting
Coding conventions
+ Linking manuals

diff --git a/deal.II/doc/development/toc.html b/deal.II/doc/development/toc.html index f9d271739b..fa26f7e3e2 100644 --- a/deal.II/doc/development/toc.html +++ b/deal.II/doc/development/toc.html @@ -73,7 +73,14 @@ target="_top">bug tracking system and enter a new ticket for your issue.

- + +

Linking your online documentation + to the deal.II online manual: after spending a lot of time + writing good documentation for your code and putting it online, + here we explain how to put links to the deal.II online manual into + your documentation, so that readers can click through. +

Running the testsuite: deal.II has a testsuite that we run to make sure that our tests don't break any existing diff --git a/deal.II/doc/doxygen/headers/main.h b/deal.II/doc/doxygen/headers/main.h index 8bed63010d..5e02bab37e 100644 --- a/deal.II/doc/doxygen/headers/main.h +++ b/deal.II/doc/doxygen/headers/main.h @@ -2,7 +2,7 @@ // $Id$ // Version: $Name$ // -// Copyright (C) 2006, 2007, 2010, 2011 by the deal.II authors +// Copyright (C) 2006, 2007, 2010, 2011, 2012 by the deal.II authors // // This file is subject to QPL and may not be distributed // without copyright and license information. Please refer @@ -253,4 +253,18 @@ * the menu bar at the top of this page, and are also grouped into * modules of their own (see the Modules linke * at the top of this page). + * + * We provide the Doxygen tag file for those of you who would like to directly link the + * documentation of application programs to the deal.II online documentation. The tag file + * is at deal.tag. For each release of deal.II, + * it resides in the directory right above the Doxygen reference documentation. In order + * to use the tag file, you have to download it into a place where Doxygen can find it. + * After that, find the key TAGFILES in your Doxygen options file and write something like + *

+ * TAGFILES = deal.tag=http://www.dealii.org/X.Y.Z/doxygen/deal.II
+ *

+ * where X.Y.Z refers to the release you want to link to. Be sure you use + * the matching tag file. In theorey, you can also link against the developing revisions + * of deal.II, but then you have to fear that your links may become invalid if + * the deal.II structure changes. */ -- 2.39.5