COIN-OR::LEMON - Graph Library

Opened 11 years ago

Closed 11 years ago

#248 closed enhancement (fixed)

Various doc improvements

Reported by: Peter Kovacs Owned by: Peter Kovacs
Priority: major Milestone: LEMON 1.1 release
Component: core Version: hg main
Keywords: Cc:
Revision id:

Description


Attachments (2)

doc-impr-259f61026d81.patch (175.7 KB) - added by Peter Kovacs 11 years ago.
doc-impr-c5fd2d996909.patch (174.7 KB) - added by Peter Kovacs 11 years ago.

Download all attachments as: .zip

Change History (7)

Changed 11 years ago by Peter Kovacs

Attachment: doc-impr-259f61026d81.patch added

comment:1 Changed 11 years ago by Peter Kovacs

[259f61026d81] contains various doc improvements:

  • Rename all the ugly template parameters (too long and/or starting with an underscore).
  • Rename function parameters starting with an underscore.
  • Extend the doc for many classes.
  • Use LaTeX-style O(...) expressions everywhere.
  • A lot of small unification changes.
  • Small fixes.
  • Some other improvements.

comment:2 in reply to:  1 Changed 11 years ago by Alpar Juttner

Replying to kpeter:

[259f61026d81] contains various doc improvements:

I like most of the changes, but

  • Use LaTeX-style O(...) expressions everywhere.

I'm not 100% sure if it is a good idea.

Firstly, it slows down the doc generation. Secondly, LaTeX expressions have a major drawback that they do not (always) scale with the surrounding text when zooming. Sometimes, the expressions differ in size from the text even using the default browser settings.

Thus I prefer to keep the simple text for easy expressions like O(n), or O(n2), even if - in theory - the LaTeX expressions render much better.

comment:3 Changed 11 years ago by Alpar Juttner

Very good. Trac understand superscripts. So mu last sentence above should read as

Thus I prefer to keep the simple text for easy expressions like O(n), or O(n^2), even if - in theory - the LaTeX expressions render much better.

Btw can't doxygen generate subscripts/superscripts?

Changed 11 years ago by Peter Kovacs

Attachment: doc-impr-c5fd2d996909.patch added

comment:4 in reply to:  3 ; Changed 11 years ago by Peter Kovacs

Replying to alpar:

Thus I prefer to keep the simple text for easy expressions like O(n), or O(n^2), even if - in theory - the LaTeX expressions render much better.

I attached the modified changeset [c5fd2d996909].

Btw can't doxygen generate subscripts/superscripts?

It can, since it supports <sup>, </sup>, <sub>, </sub> html tags.

comment:5 in reply to:  4 Changed 11 years ago by Alpar Juttner

Resolution: fixed
Status: newclosed

Replying to kpeter:

I attached the modified changeset [c5fd2d996909].

It went to the main.

Note: See TracTickets for help on using tickets.