From 1af900eff3eceab3c02c2ae617e84d590f29c139 Mon Sep 17 00:00:00 2001 From: Matthias Maier Date: Mon, 21 Jul 2014 18:15:47 +0200 Subject: [PATCH] Documentation: Remove bogus indentation.html file Well, we already have a detailed doxygen file about indentation. So it is better to add the three relevant lines about astyle there and remove this additional documentation page completely --- doc/developers/indentation.html | 53 ------------------------ doc/developers/index.html | 2 +- doc/developers/navbar.html | 2 +- doc/developers/svn.html | 2 +- doc/doxygen/headers/coding_conventions.h | 19 +++++++++ 5 files changed, 22 insertions(+), 56 deletions(-) delete mode 100644 doc/developers/indentation.html diff --git a/doc/developers/indentation.html b/doc/developers/indentation.html deleted file mode 100644 index a042f26ffe..0000000000 --- a/doc/developers/indentation.html +++ /dev/null @@ -1,53 +0,0 @@ - - - - deal.II indentation - - - - - - - -

Notes on deal.II indentation

- -

deal.II uses astyle to normalize indentation. A - style file is provided at - - DEAL/contrib/utilities/astyle.rc - - where DEAL is the path to you deal.II source directory.

- -

All header and source files in the SVN repository are supposed - to conform to this style file. It is very important that we adhere - to this indentation style in order to avoid false conflicts on svn - updates.

- -

Before every commit, you should run - - astyle --options=DEAL/contrib/utilities/astyle.rc - - on each of your files. This will make sure indentation is - conforming to our style.

- -

Upon commit, svn will output comments on the conformity of your files. If you see a line of the form - - !! file style mismatch detected - - please re-indent the file. SVN may reject those files soon!

- -

- The deal.II Authors - $Date$ -

- -

- -

- - - diff --git a/doc/developers/index.html b/doc/developers/index.html index 2f48408b09..4c50ec4977 100644 --- a/doc/developers/index.html +++ b/doc/developers/index.html @@ -6,7 +6,7 @@ deal.II Development Information - + diff --git a/doc/developers/navbar.html b/doc/developers/navbar.html index 9c270ad68a..af077e9ed3 100644 --- a/doc/developers/navbar.html +++ b/doc/developers/navbar.html @@ -5,7 +5,7 @@ deal.II Development Navigation Bar - + diff --git a/doc/developers/svn.html b/doc/developers/svn.html index 81b1463b0d..4a69f9b6da 100644 --- a/doc/developers/svn.html +++ b/doc/developers/svn.html @@ -5,7 +5,7 @@ deal.II SVN Archive - + diff --git a/doc/doxygen/headers/coding_conventions.h b/doc/doxygen/headers/coding_conventions.h index cf423e395f..57d96575d8 100644 --- a/doc/doxygen/headers/coding_conventions.h +++ b/doc/doxygen/headers/coding_conventions.h @@ -30,6 +30,25 @@ before output arguments of a function call. They also simplify reading code because some things become clear already by looking at the style a piece of code is written, without having to look up the exact definition of something. +

Notes on deal.II indentation

+ +

deal.II uses astyle to normalize indentation. A +style file is provided at ++

+  ./contrib/utilities/astyle.rc
+

+ +

Before a commit, you should run ++

+  astyle --options=<SOURCE DIRECTORY>/contrib/utilities/astyle.rc <file>
+

+on each of your files. This will make sure indentation is conforming to the +style guidelines outlined in this page.

Style issues

-- 2.39.5