From d21d3125e7146475b89397c63d97b8d65b539355 Mon Sep 17 00:00:00 2001 From: Ian Rees Date: Mon, 14 Jul 2014 15:30:51 +1200 Subject: [PATCH] Have cmake set doxygen to use dot if it's available. Also a minor typos --- src/Doc/BuildDevDoc.cfg.in | 2 +- src/Doc/CMakeLists.txt | 1 + src/Doc/doctips.dox | 5 ++++- src/Doc/mainpage.dox | 2 +- src/Gui/DlgKeyboardImp.h | 2 +- 5 files changed, 8 insertions(+), 4 deletions(-) diff --git a/src/Doc/BuildDevDoc.cfg.in b/src/Doc/BuildDevDoc.cfg.in index dfda719e8..1c0878ea4 100644 --- a/src/Doc/BuildDevDoc.cfg.in +++ b/src/Doc/BuildDevDoc.cfg.in @@ -1566,7 +1566,7 @@ HIDE_UNDOC_RELATIONS = YES # toolkit from AT&T and Lucent Bell Labs. The other options in this section # have no effect if this option is set to NO (the default) -HAVE_DOT = NO +HAVE_DOT = @HAVE_DOT@ # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is # allowed to run in parallel. When set to 0 (the default) doxygen will diff --git a/src/Doc/CMakeLists.txt b/src/Doc/CMakeLists.txt index ac445b484..fe0774624 100644 --- a/src/Doc/CMakeLists.txt +++ b/src/Doc/CMakeLists.txt @@ -4,6 +4,7 @@ if(DOXYGEN_FOUND) IF (DOXYGEN_DOT_EXECUTABLE) SET(HAVE_DOT YES) ELSE (DOXYGEN_DOT_EXECUTABLE) + message("Note: Doxygen docs will look better with graphviz's dot installed.") SET(HAVE_DOT NO) ENDIF (DOXYGEN_DOT_EXECUTABLE) diff --git a/src/Doc/doctips.dox b/src/Doc/doctips.dox index 2cb587bea..a11981cd3 100644 --- a/src/Doc/doctips.dox +++ b/src/Doc/doctips.dox @@ -1,6 +1,9 @@ /** \page doctips Documenting FreeCAD's code -Below are a few remarks and notes about Doxygen usage for FreeCAD, gathered after examining and removing most of the warnings emited by Doxygen: +Below are a few remarks and notes about Doxygen usage for FreeCAD, +gathered after examining and removing most of the warnings emitted +by Doxygen. For information on (re)building the source docs, see +\ref makingdocs - Pay attention to warnings emited by doxygen when building the doc. The item giving rise to the warning will be skipped and will not be diff --git a/src/Doc/mainpage.dox b/src/Doc/mainpage.dox index e871d2a13..b2ef1fd7d 100644 --- a/src/Doc/mainpage.dox +++ b/src/Doc/mainpage.dox @@ -38,7 +38,7 @@ Wiki FreeCAD being a fast moving target, don't hesitate to rebuild an up to - date doc from svn source as often as needed. CPU cycles are cheap + date doc from source as often as needed (\ref makingdocs "more info"). CPU cycles are cheap nowadays! The homepage of FreeCAD is here. diff --git a/src/Gui/DlgKeyboardImp.h b/src/Gui/DlgKeyboardImp.h index 29ca3d63b..e32448fe4 100644 --- a/src/Gui/DlgKeyboardImp.h +++ b/src/Gui/DlgKeyboardImp.h @@ -33,7 +33,7 @@ namespace Dialog { /** Shows an overview of all available commands of all groups and modules. * You can customize your workbenches just by drag&dropping any commands * onto the toolbars or commandbars. But you cannot modify any standard toolbars or - * commandbars such as "File, View, ...". It is only poosible to + * commandbars such as "File, View, ...". It is only possible to * customize your own toolbars or commandbars. * \author Werner Mayer */