Skip to content

Commit

Permalink
Optimize Doxygen docs some
Browse files Browse the repository at this point in the history
  • Loading branch information
lmoureaux committed Aug 10, 2022
1 parent cfb6139 commit 885bba9
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 13 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,6 @@ build.ninja
.vs
# Project file
*.kdev4

# In case someone runs Doxygen
/doc/doxygen
18 changes: 8 additions & 10 deletions client/renderer.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,8 @@ namespace freeciv {
* @class renderer
* @brief Renders the map on widgets
*
* This class is used to draw the map. It can handle zoom via the @ref scale
* property.
*
* @property scale By how much the map is scaled before being drawn (a scale
* of 2 means that everything is 2x bigger)
* This class is used to draw the map. The position of the mapview is given by
* @ref origin and zoom is set via the @ref scale property.
*/

/**
Expand All @@ -27,7 +24,8 @@ namespace freeciv {
renderer::renderer(QObject *parent) : QObject(parent) {}

/**
* Changes the scale of the rendering (zooms in or out).
* Changes the scale of the rendering (zooms in or out). A scale of 2 means
* that everything is 2x bigger.
*/
void renderer::set_scale(double scale)
{
Expand All @@ -53,9 +51,9 @@ void renderer::set_viewport_size(const QSize &size)
}

/**
* Renders the specified region of the visible portion of the map on @c
* Renders the specified @c region of the visible portion of the map on @c
* painter.
* @see @ref render(QPainter&, const QRect&)
* @overload
*/
void renderer::render(QPainter &painter, const QRegion &region) const
{
Expand All @@ -67,8 +65,8 @@ void renderer::render(QPainter &painter, const QRegion &region) const
/**
* Renders the specified area of the visible portion of the map on @c
* painter. This is meant to be used directly from @c paintEvent, so the
* position of
* @c area is relative to the @ref viewport.
* position of @c area is relative to the viewport.
* @overload
*/
void renderer::render(QPainter &painter, const QRect &area) const
{
Expand Down
6 changes: 3 additions & 3 deletions doc/freeciv.doxygen
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ SHORT_NAMES = NO
# description.)
# The default value is: NO.

JAVADOC_AUTOBRIEF = NO
JAVADOC_AUTOBRIEF = YES

# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
# line (until the first dot) of a Qt-style comment as the brief description. If
Expand Down Expand Up @@ -242,7 +242,7 @@ TCL_SUBST =
# members will be omitted, etc.
# The default value is: NO.

OPTIMIZE_OUTPUT_FOR_C = YES
OPTIMIZE_OUTPUT_FOR_C = NO

# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
# Python sources only. Doxygen will then generate output that is more tailored
Expand Down Expand Up @@ -309,7 +309,7 @@ AUTOLINK_SUPPORT = YES
# diagrams that involve STL classes more complete and accurate.
# The default value is: NO.

BUILTIN_STL_SUPPORT = NO
BUILTIN_STL_SUPPORT = YES

# If you use Microsoft's C++/CLI language, you should set this option to YES to
# enable parsing support.
Expand Down

0 comments on commit 885bba9

Please sign in to comment.