Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changeset 7292 for code/branches/doc/src


Ignore:
Timestamp:
Aug 31, 2010, 5:40:59 PM (14 years ago)
Author:
landauf
Message:

fixed some misspelled doxygen tags (note: doxygen is case-sensitive and all tags are lowercase)

Location:
code/branches/doc/src
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • code/branches/doc/src/libraries/core/Game.h

    r7266 r7292  
    5353
    5454/**
    55 @def
     55@brief
    5656    Adds a new GameState to the Game. The second parameter is the name as string
    5757    and every following paramter is a constructor argument (which is usually non existent)
  • code/branches/doc/src/orxonox/worldentities/WorldEntity.cc

    r7163 r7292  
    267267    @brief
    268268        Attaches this object to a parent SceneNode.
    269     @Remarks
     269    @remarks
    270270        Only use this method if you know exactly what you're doing!
    271271        Normally, attaching works internally by attaching WE's.
     
    282282    @brief
    283283        Detaches this object from a parent SceneNode.
    284     @Remarks
     284    @remarks
    285285        Only use this method if you know exactly what you're doing!
    286286        Normally, attaching works internally by attaching WE's.
     
    355355        Attaches a child WorldEntity to this object. This calls notifyBeingAttached()
    356356        of the child WE.
    357     @Note
     357    @note
    358358        The collision shape of the child object gets attached nevertheless. That also means
    359359        that you can change the collision shape of the child and it correctly cascadeds the changes to this instance.
     
    628628    @brief
    629629        Sets the three dimensional scaling of this object.
    630     @Note
     630    @note
    631631        Scaling physical objects has not yet been implemented and is therefore forbidden.
    632632    */
     
    774774    @brief
    775775        Sets the CollisionType. This alters the object significantly! @see CollisionType.
    776     @Note
     776    @note
    777777        Operation does not work on attached WorldEntities.
    778778    */
     
    900900        Recalculates the accumulated child mass and calls recalculateMassProps()
    901901        and notifies the parent of the change.
    902     @Note
     902    @note
    903903        Called by a child WE
    904904    */
     
    919919    @brief
    920920        Undertakes the necessary steps to change the collision shape in Bullet, even at runtime.
    921     @Note
     921    @note
    922922        - called by this->collisionShape_
    923923        - May have a REALLY big overhead when called continuously at runtime, because then we need
  • code/branches/doc/src/orxonox/worldentities/WorldEntity.h

    r7163 r7292  
    299299            @brief
    300300                Returns the diagonal elements of the inertia tensor when calculated in local coordinates.
    301             @Note
     301            @note
    302302                The local inertia tensor cannot be set, but is calculated by Bullet according to the collisionShape.
    303303                With compound collision shapes, an approximation is used.
     
    367367            @param otherObject
    368368                The object this one has collided into.
    369             @pram contactPoint
     369            @param contactPoint
    370370                Contact point provided by Bullet. Holds more information and can me modified. See return value.
    371             @Return
     371            @return
    372372                Returning false means that no modification to the contactPoint has been made. Return true otherwise!
    373             @Note
     373            @note
    374374                Condition is that enableCollisionCallback() was called.
    375375            */
Note: See TracChangeset for help on using the changeset viewer.