Skip to content

Commit

Permalink
Documentation|LineDef|Fixed: LineDef apidoc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
danij-deng committed Apr 9, 2013
1 parent b9c4147 commit 76c680a
Showing 1 changed file with 8 additions and 9 deletions.
17 changes: 8 additions & 9 deletions doomsday/client/include/map/linedef.h
Expand Up @@ -144,7 +144,7 @@ class LineDef : public de::MapElement
inline Sector *sectorPtr() const { return hasSector()? &sector() : 0; }

/**
* Returns @c true iff a Sector is attributed to the side.
* Returns @c true iff a SideDef is attributed to the side.
*/
bool hasSideDef() const;

Expand All @@ -163,7 +163,7 @@ class LineDef : public de::MapElement
inline SideDef *sideDefPtr() const { return hasSideDef()? &sideDef() : 0; }

/**
* Returns the left-moset HEdge for the side.
* Returns the left-most HEdge for the side.
*/
HEdge &leftHEdge() const;

Expand All @@ -173,22 +173,21 @@ class LineDef : public de::MapElement
HEdge &rightHEdge() const;

/**
* Update the side's map space surface base origins according to the points
* defined by the associated LineDef's vertices and the plane heights of the
* Sector on this side. If no LineDef is presently associated this is a no-op.
* Update the side's sound emitter origins according to the points defined by
* the LineDef's vertices and the plane heights of the Sector on this side.
* If no SideDef is associated this is a no-op.
*/
void updateSoundEmitterOrigins();

/**
* Update the tangent space normals of the side's surfaces according to the
* points defined by the associated LineDef's vertices. If no LineDef is
* presently associated this is a no-op.
* points defined by the LineDef's vertices. If no SideDef is associated this
* is a no-op.
*/
void updateSurfaceNormals();

/**
* Returns the frame number of the last time shadows linked to the side
* were drawn.
* Returns the frame number of the last time shadows were drawn for the side.
*/
int shadowVisCount() const;
};
Expand Down

0 comments on commit 76c680a

Please sign in to comment.