From: Matthias Maier
- Home
- CMake internals
-
-
-
-
- README
- User info
- Developer info
-
-
- Development
-
-
- Writing documentation
- Porting
- Coding conventions
- Testsuite
-
-
-
diff --git a/doc/developers/title.html b/doc/developers/title.html
deleted file mode 100644
index d57bda21dc..0000000000
--- a/doc/developers/title.html
+++ /dev/null
@@ -1,28 +0,0 @@
-
-
-
-
-
- Information for Developers
-
- Information for Developers
-
-
-This page provides documentation for deal.II developers. At present, we
-have the following resources available:
-
- Build system internals: - This page provides implementation and development details about - the CMake build system. - -
Writing - documentation: To document the library and our - application programs, we use - doxygen. - This page documents the basics of the format in - which the documentation needs to be written in order to - enable automatic documentation generation. -
- -Porting - deal.II to a new system: - - deal.II uses CMake as build system and is fairly - ISO (1998) C++ Standard compliant. So, porting to a reasonably POSIX - compliant system with a reasonably ISO C++ compliant compiler shouldn't - be much work. Other (mostly proprietary) systems might require more - work. See the ReadMe file for - more information on already supported systems. This resource gives some - hints for porting to unknown platforms. -
- -Coding conventions: We try to adhere to a - set of coding conventions to ensure that the use of different - parts of the library is as uniform as possible. Please read - through them if you think about contributing code. - -
Running the testsuite: - deal.II has a testsuite that we run to - make sure that our tests don't break any existing - functionality. This page explains its use. -
-+ Information for users +
+ Information for developers +
Home
README
- User info
- Developer info
- Home
- README
- User info
- Developer info
-
- CMake documentation
- CMake in user projects
- Linking manuals
-
-
-This page gathers some information on developing programs based on
-deal.II, as well as on how to configure and use
-deal.II. At present, we have the following resources
-available:
-
- deal.II CMake documentation: - This page provides extensive information about configuration and - installation with the CMake build system. - -
Using CMake and
- deal.II in a user project:
- This page covers how to use CMake in your own project.
- An overview of how to retrieve necessary information
- from a deal.II installation as well as how to
- write a CMakeLists.txt
for a client project is given.
-
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. -
- -- The tutorial is for new users of the - library. It explains the basic elements of finite element - programs based on the library, and provides small example - programs. - There are also Youtube-hosted video lectures that provide, both, the - context of the mathematical and computational methods of deal.II, as well - as demonstrate parts of the tutorial. -
- -- As all other documentation, the HTML pages - of the tutorials can be generated locally on your computer and - can then be read offline. Please follow the - instructions in the - ReadMe on how to - generate them locally. -
- - --The programming - interface/manual pages are what you will need most often as a -reference of all classes, functions and variables in the library. They -are extensively documented (presently more than 5000 pages if -printed), and generated by Doxygen. There is also a quick link to these pages from -the menu bar at the left. -
- --The documentation uses many of the features of Doxygen. In particular, -the link takes you straight to a page that lists modules, a way -to group classes with similar purposes. This may be what you are probably -interested in when you are not yet familiar with the library. If you -already know your way around and want to look up the signature of a -particular member function, for example, you may go to the class view or -choose any of the other ways in which Doxygen allows you to navigate -through the documentation. -
- --Just as for the tutorials, the API docs need to be generated first, -if you download deal.II. Please follow the -instructions in the -ReadMe on how to do -this. -
- -