Gael Guennebaud
acc3459a49
Add help messages in the quick ref/ascii docs regarding slicing, indexing, and reshaping.
2018-12-05 17:17:23 +01:00
Gael Guennebaud
dffd1e11de
Limit the size of the toc
2018-11-09 13:52:34 +01:00
Gael Guennebaud
79266fec75
extend doxygen splitter for huge screens
2018-04-11 11:31:17 +02:00
luz.paz
e3912f5e63
MIsc. source and comment typos
...
Found using `codespell` and `grep` from downstream FreeCAD
2018-03-11 10:01:44 -04:00
Gael Guennebaud
59801a3250
Add \newin{3.x} doxygen command
2017-01-17 10:31:28 +01:00
Gael Guennebaud
cd221a62ee
Doc: start of a table summarizing coefficient-wise math functions.
2016-06-01 17:09:48 +02:00
Gael Guennebaud
ce12562710
Add some c++11 flags in documentation
2016-05-19 17:35:30 +02:00
Gael Guennebaud
091a49cad5
Clean the manual page titles, links and intro.
2013-01-06 23:48:59 +01:00
Gael Guennebaud
86983fa1ff
Update the overview page to reflect the new organisation
2013-01-05 21:25:41 +01:00
Gael Guennebaud
2de69c2f26
Doc presentation:
...
- remove the "modules|classes" link for module pages (they are already in the TOC)
- fine tune the TOC css
2013-01-05 17:14:14 +01:00
Gael Guennebaud
93ee82b1fd
Big changes in Eigen documentation:
...
- Organize the documentation into "chapters".
- Each chapter include many documentation pages, reference pages organized as modules, and a quick reference page.
- The "Chapters" tree is created using the defgroup/ingroup mechanism, even for the documentation pages (i.e., .dox files for which I added an \eigenManualPage macro that we can switch between \page or \defgroup ).
- Add a "General topics" entry for all pages that do not fit well in the previous "chapters".
- The highlevel struture is managed by a new eigendoxy_layout.xml file.
- remove the "index" and quite useless pages (namespace list, class hierarchy, member list, file list, etc.)
- add the javascript search-engine.
- add the "treeview" panel.
- remove \tableofcontents (replace them by a custom \eigenAutoToc macro to be able to easily re-enable if needed).
- add javascript to automatically generate a TOC from the h1/h2 tags of the current page, and put the TOC in the left side panel.
- overload various javascript function generated by doxygen to:
- remove the root of the treeview
- remove links to section/subsection from the treeview
- automatically expand the "Chapters" section
- automatically expand the current section
- adjust the height of the treeview to take into account the TOC
- always use the default .css file, eigendoxy.css now only includes our modifications
- use Doxyfile to specify our logo
- remove cross references to unsupported modules (temporarily)
2013-01-05 16:37:11 +01:00
Gael Guennebaud
ded70b8b58
Doc: remove page margins and limits to 60em paragraphes only instaead of the entire page (many declarations and tables are larger than 60em anyway)
2012-12-28 18:57:10 +01:00
Gael Guennebaud
3f82401890
Update doxygen files to doxygen version 1.8
2012-12-28 18:52:53 +01:00
Gael Guennebaud
3f56de2628
improve sparse manual
2011-12-03 10:26:00 +01:00
Gael Guennebaud
e5073746f3
allows blocks of code to be larger than the page body (like tables)
2010-10-19 16:55:49 +02:00
Gael Guennebaud
e19c6b89f5
update the position of the owl
2010-10-19 16:07:04 +02:00
Gael Guennebaud
54814eb05b
factorize CSS code, make use of the "manual" class when appropriate, clean the style of the big linear algebra table
2010-10-19 15:25:00 +02:00
Benoit Jacob
70f95ef80d
increase css max-width
2010-10-19 09:40:23 -04:00
Benoit Jacob
b1604ea553
merge
2010-10-19 09:32:19 -04:00
Benoit Jacob
b8dfc62f3c
specify max-width in em not px
2010-10-19 09:31:22 -04:00
Gael Guennebaud
6d8e7d68e4
factorize CSS code, make use of the "manual" class when appropriate, clean the style of the big linear algebra table
2010-10-19 15:25:00 +02:00
Benoit Jacob
9e3005d552
css update: max-width and margins
2010-10-19 09:18:06 -04:00
Gael Guennebaud
ca4bd5851c
update style of the quick ref guide
2010-10-19 11:59:11 +02:00
Gael Guennebaud
f66fe2663f
update CSS to doxygen 1.7.2, new CSS and cleaning of the tutorial
2010-10-19 11:40:49 +02:00
Hauke Heibel
34d79b6a63
Firefox specific style fix.
2010-06-30 18:31:31 +02:00
Hauke Heibel
7b74d376d3
More style fixes.
2010-06-30 18:27:27 +02:00
Hauke Heibel
e1348b9cc9
Slight pimping of the "Basic matrix manipulation" table.
...
More CSS simplifications.
2010-06-30 18:04:36 +02:00
Hauke Heibel
b1741c1dc6
Fixed some doc appearance issue.
...
Started cleaning up the CSS.
2010-06-30 15:52:00 +02:00
Hauke Heibel
56fe64c15d
Fix hover background color for H2.
...
Align tutorial tables at the top.
2010-06-30 14:05:37 +02:00
Jitse Niesen
af08770890
Center version number on main page of API documentation.
2010-03-26 12:36:42 +00:00
Hauke Heibel
90d5a7c0dd
Adapted doxygen's new style sheet.
...
Added documentation to some of the typedefs.
2010-01-15 15:45:07 +01:00
Hauke Heibel
624902f559
Enabled class diagrams (requires dot, i.e. graphviz).
...
Adapted the style sheet in order to center class diagrams.
2010-01-13 17:59:42 +01:00
Gael Guennebaud
727dfa1c43
fix some documentation issues
2008-10-17 11:20:46 +00:00
Gael Guennebaud
6825c8dd6b
QTransform conversion and doc
2008-09-01 06:33:19 +00:00
Gael Guennebaud
994629721a
update of the geometry tutorial
2008-08-31 17:30:09 +00:00
Gael Guennebaud
70266b4d05
doc + quick bug fix in Matrix ctor
2008-08-28 00:33:58 +00:00
Gael Guennebaud
00a8d314c5
* move memory related stuff to util/Memory.h
...
* clean ugly doxygen inheritence of expressions
* keep improving the documentation... slowly !
2008-08-26 19:12:23 +00:00
Gael Guennebaud
9e25dfcb2c
Various doc improvements... including a owl in the API doc header.
2008-08-25 10:49:53 +00:00
Gael Guennebaud
854d6e8458
Documentation: fill the placeholders, add a custom CSS file,
...
add a reference to the tutorial in the main page.
2008-08-24 19:14:20 +00:00