TheCloud/panda3d
1
0
Fork 0
mirror of https://github.com/panda3d/panda3d.git synced 2025-10-02 09:52:27 -04:00
Code Issues Packages Projects Releases Wiki Activity

Change some .T files to new docstring style that were missed

Browse Source
This commit is contained in:
rdb 2018-06-01 20:44:30 +02:00
parent 159b43e563
commit 213ae6b029
3 changed files with 115 additions and 161 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

79
panda/src/express/dcast.T
View File

@ -1,24 +1,20 @@
// Filename: dcast.T /**
// Created by: drose (06Aug01) * PANDA 3D SOFTWARE
// * Copyright (c) Carnegie Mellon University. All rights reserved.
//////////////////////////////////////////////////////////////////// *
// * All use of this software is subject to the terms of the revised BSD
// PANDA 3D SOFTWARE * license. You should have received a copy of this license along
// Copyright (c) Carnegie Mellon University. All rights reserved. * with this source code in a file named "LICENSE."
// *
// All use of this software is subject to the terms of the revised BSD * @file dcast.T
// license. You should have received a copy of this license along * @author drose
// with this source code in a file named "LICENSE." * @date 2001-08-06
// */
////////////////////////////////////////////////////////////////////
/**
//////////////////////////////////////////////////////////////////// * Returns the TypeHandle associated with the type of the parameter, if it can
// Function: _dcast_get_typehandle * be determined. This is a support function for _dcast, below.
// Description: Returns the TypeHandle associated with the type of */
// the parameter, if it can be determined. This is a
// support function for _dcast, below.
////////////////////////////////////////////////////////////////////
template<class WantType> template<class WantType>
INLINE TypeHandle INLINE TypeHandle
_dcast_get_typehandle(WantType *) { _dcast_get_typehandle(WantType *) {
@ -38,16 +34,13 @@ _dcast_get_typehandle(WantType *) {
return handle; return handle;
} }
/**
//////////////////////////////////////////////////////////////////// * The implementation of the DCAST macro, this checks the actual type of the
// Function: _dcast * pointer before performing a downcast operation. In NDEBUG mode, it simply
// Description: The implementation of the DCAST macro, this checks * downcasts.
// the actual type of the pointer before performing a *
// downcast operation. In NDEBUG mode, it simply * This flavor of _dcast works on non-const pointers.
// downcasts. */
//
// This flavor of _dcast works on non-const pointers.
////////////////////////////////////////////////////////////////////
template<class WantType> template<class WantType>
INLINE WantType * INLINE WantType *
_dcast(WantType *, TypedObject *ptr) { _dcast(WantType *, TypedObject *ptr) {
@ -61,15 +54,13 @@ _dcast(WantType *, TypedObject *ptr) {
return (WantType *)ptr; return (WantType *)ptr;
} }
//////////////////////////////////////////////////////////////////// /**
// Function: _dcast * The implementation of the DCAST macro, this checks the actual type of the
// Description: The implementation of the DCAST macro, this checks * pointer before performing a downcast operation. In NDEBUG mode, it simply
// the actual type of the pointer before performing a * downcasts.
// downcast operation. In NDEBUG mode, it simply *
// downcasts. * This flavor of _dcast works on const pointers.
// */
// This flavor of _dcast works on const pointers.
////////////////////////////////////////////////////////////////////
template<class WantType> template<class WantType>
INLINE const WantType * INLINE const WantType *
_dcast(WantType *, const TypedObject *ptr) { _dcast(WantType *, const TypedObject *ptr) {
@ -83,12 +74,10 @@ _dcast(WantType *, const TypedObject *ptr) {
return (const WantType *)ptr; return (const WantType *)ptr;
} }
//////////////////////////////////////////////////////////////////// /**
// Function: _dcast_ref * Similar to the above, with a pointer reference as the first parameter.
// Description: Similar to the above, with a pointer reference as the * Just for fiddly compiler reasons; the reference isn't used.
// first parameter. Just for fiddly compiler reasons; */
// the reference isn't used.
////////////////////////////////////////////////////////////////////
template<class WantType> template<class WantType>
INLINE WantType * INLINE WantType *
_dcast_ref(WantType *&, TypedObject *ptr) { _dcast_ref(WantType *&, TypedObject *ptr) {

151
panda/src/express/ordered_vector.T
View File

@ -1,32 +1,26 @@
// Filename: ordered_vector.T /**
// Created by: drose (20Feb02) * PANDA 3D SOFTWARE
// * Copyright (c) Carnegie Mellon University. All rights reserved.
//////////////////////////////////////////////////////////////////// *
// * All use of this software is subject to the terms of the revised BSD
// PANDA 3D SOFTWARE * license. You should have received a copy of this license along
// Copyright (c) Carnegie Mellon University. All rights reserved. * with this source code in a file named "LICENSE."
// *
// All use of this software is subject to the terms of the revised BSD * @file ordered_vector.T
// license. You should have received a copy of this license along * @author drose
// with this source code in a file named "LICENSE." * @date 2002-02-02
// */
////////////////////////////////////////////////////////////////////
/**
//////////////////////////////////////////////////////////////////// * Inserts the indicated key into the ordered vector. The iterator is a hint
// Function: ordered_vector::insert_unique * to the expected position; if this is correct, the insert operation is
// Access: Public * likely to be faster. The return value is the iterator referencing the new
// Description: Inserts the indicated key into the ordered vector. * element.
// The iterator is a hint to the expected position; if *
// this is correct, the insert operation is likely to be * This flavor of insert does not allow multiple copies of the same key to be
// faster. The return value is the iterator referencing * inserted. If the key is already present, it is not inserted, and the
// the new element. * iterator referencing the original value is returned.
// */
// This flavor of insert does not allow multiple copies
// of the same key to be inserted. If the key is
// already present, it is not inserted, and the iterator
// referencing the original value is returned.
////////////////////////////////////////////////////////////////////
template<class Key, class Compare, class Vector> template<class Key, class Compare, class Vector>
TYPENAME ordered_vector<Key, Compare, Vector>::ITERATOR ordered_vector<Key, Compare, Vector>:: TYPENAME ordered_vector<Key, Compare, Vector>::ITERATOR ordered_vector<Key, Compare, Vector>::
insert_unique(TYPENAME ordered_vector<Key, Compare, Vector>::ITERATOR position, insert_unique(TYPENAME ordered_vector<Key, Compare, Vector>::ITERATOR position,
@ -62,18 +56,16 @@ insert_unique(TYPENAME ordered_vector<Key, Compare, Vector>::ITERATOR position,
return result; return result;
} }
////////////////////////////////////////////////////////////////////
// Function: ordered_vector::insert_nonunique /**
// Access: Public * Inserts the indicated key into the ordered vector. The iterator is a hint
// Description: Inserts the indicated key into the ordered vector. * to the expected position; if this is correct, the insert operation is
// The iterator is a hint to the expected position; if * likely to be faster. The return value is the iterator referencing the new
// this is correct, the insert operation is likely to be * element.
// faster. The return value is the iterator referencing *
// the new element. * This flavor of insert allows multiple copies of the
// * same key to be inserted.
// This flavor of insert allows multiple copies of the */
// same key to be inserted.
////////////////////////////////////////////////////////////////////
template<class Key, class Compare, class Vector> template<class Key, class Compare, class Vector>
TYPENAME ordered_vector<Key, Compare, Vector>::ITERATOR ordered_vector<Key, Compare, Vector>:: TYPENAME ordered_vector<Key, Compare, Vector>::ITERATOR ordered_vector<Key, Compare, Vector>::
insert_nonunique(TYPENAME ordered_vector<Key, Compare, Vector>::ITERATOR position, insert_nonunique(TYPENAME ordered_vector<Key, Compare, Vector>::ITERATOR position,
@ -100,13 +92,10 @@ insert_nonunique(TYPENAME ordered_vector<Key, Compare, Vector>::ITERATOR positio
return result; return result;
} }
//////////////////////////////////////////////////////////////////// /**
// Function: ordered_vector::verify_list_unique * Ensures that the indicated range of elements is sorted correctly. Returns
// Access: Public * true if this is the case; otherwise, returns false.
// Description: Ensures that the indicated range of elements is */
// sorted correctly. Returns true if this is the case;
// otherwise, returns false.
////////////////////////////////////////////////////////////////////
template<class Key, class Compare, class Vector> template<class Key, class Compare, class Vector>
bool ordered_vector<Key, Compare, Vector>:: bool ordered_vector<Key, Compare, Vector>::
verify_list_unique() const { verify_list_unique() const {
@ -127,13 +116,10 @@ verify_list_unique() const {
return true; return true;
} }
//////////////////////////////////////////////////////////////////// /**
// Function: ordered_vector::verify_list_nonunique * Ensures that the indicated range of elements is sorted correctly. Returns
// Access: Public * true if this is the case; otherwise, returns false.
// Description: Ensures that the indicated range of elements is */
// sorted correctly. Returns true if this is the case;
// otherwise, returns false.
////////////////////////////////////////////////////////////////////
template<class Key, class Compare, class Vector> template<class Key, class Compare, class Vector>
bool ordered_vector<Key, Compare, Vector>:: bool ordered_vector<Key, Compare, Vector>::
verify_list_nonunique() const { verify_list_nonunique() const {
@ -155,12 +141,9 @@ verify_list_nonunique() const {
} }
//////////////////////////////////////////////////////////////////// /**
// Function: ordered_vector::r_find_insert_position * The recursive implementation of find_insert_position().
// Access: Private */
// Description: The recursive implementation of
// find_insert_position().
////////////////////////////////////////////////////////////////////
template<class Key, class Compare, class Vector> template<class Key, class Compare, class Vector>
TYPENAME ordered_vector<Key, Compare, Vector>::ITERATOR ordered_vector<Key, Compare, Vector>:: TYPENAME ordered_vector<Key, Compare, Vector>::ITERATOR ordered_vector<Key, Compare, Vector>::
r_find_insert_position(TYPENAME ordered_vector<Key, Compare, Vector>::ITERATOR first, r_find_insert_position(TYPENAME ordered_vector<Key, Compare, Vector>::ITERATOR first,
@ -184,11 +167,9 @@ r_find_insert_position(TYPENAME ordered_vector<Key, Compare, Vector>::ITERATOR f
} }
} }
//////////////////////////////////////////////////////////////////// /**
// Function: ordered_vector::r_find * The recursive implementation of find().
// Access: Private */
// Description: The recursive implementation of find().
////////////////////////////////////////////////////////////////////
template<class Key, class Compare, class Vector> template<class Key, class Compare, class Vector>
TYPENAME ordered_vector<Key, Compare, Vector>::CONST_ITERATOR ordered_vector<Key, Compare, Vector>:: TYPENAME ordered_vector<Key, Compare, Vector>::CONST_ITERATOR ordered_vector<Key, Compare, Vector>::
r_find(TYPENAME ordered_vector<Key, Compare, Vector>::CONST_ITERATOR first, r_find(TYPENAME ordered_vector<Key, Compare, Vector>::CONST_ITERATOR first,
@ -217,11 +198,9 @@ r_find(TYPENAME ordered_vector<Key, Compare, Vector>::CONST_ITERATOR first,
} }
} }
//////////////////////////////////////////////////////////////////// /**
// Function: ordered_vector::r_find_particular * The recursive implementation of find_particular().
// Access: Private */
// Description: The recursive implementation of find_particular().
////////////////////////////////////////////////////////////////////
template<class Key, class Compare, class Vector> template<class Key, class Compare, class Vector>
TYPENAME ordered_vector<Key, Compare, Vector>::CONST_ITERATOR ordered_vector<Key, Compare, Vector>:: TYPENAME ordered_vector<Key, Compare, Vector>::CONST_ITERATOR ordered_vector<Key, Compare, Vector>::
r_find_particular(TYPENAME ordered_vector<Key, Compare, Vector>::CONST_ITERATOR first, r_find_particular(TYPENAME ordered_vector<Key, Compare, Vector>::CONST_ITERATOR first,
@ -270,11 +249,9 @@ r_find_particular(TYPENAME ordered_vector<Key, Compare, Vector>::CONST_ITERATOR
} }
} }
//////////////////////////////////////////////////////////////////// /**
// Function: ordered_vector::r_count * The recursive implementation of count().
// Access: Private */
// Description: The recursive implementation of count().
////////////////////////////////////////////////////////////////////
template<class Key, class Compare, class Vector> template<class Key, class Compare, class Vector>
TYPENAME ordered_vector<Key, Compare, Vector>::SIZE_TYPE ordered_vector<Key, Compare, Vector>:: TYPENAME ordered_vector<Key, Compare, Vector>::SIZE_TYPE ordered_vector<Key, Compare, Vector>::
r_count(TYPENAME ordered_vector<Key, Compare, Vector>::CONST_ITERATOR first, r_count(TYPENAME ordered_vector<Key, Compare, Vector>::CONST_ITERATOR first,
@ -305,11 +282,9 @@ r_count(TYPENAME ordered_vector<Key, Compare, Vector>::CONST_ITERATOR first,
} }
} }
//////////////////////////////////////////////////////////////////// /**
// Function: ordered_vector::r_lower_bound * The recursive implementation of lower_bound().
// Access: Private */
// Description: The recursive implementation of lower_bound().
////////////////////////////////////////////////////////////////////
template<class Key, class Compare, class Vector> template<class Key, class Compare, class Vector>
TYPENAME ordered_vector<Key, Compare, Vector>::CONST_ITERATOR ordered_vector<Key, Compare, Vector>:: TYPENAME ordered_vector<Key, Compare, Vector>::CONST_ITERATOR ordered_vector<Key, Compare, Vector>::
r_lower_bound(TYPENAME ordered_vector<Key, Compare, Vector>::CONST_ITERATOR first, r_lower_bound(TYPENAME ordered_vector<Key, Compare, Vector>::CONST_ITERATOR first,
@ -338,11 +313,9 @@ r_lower_bound(TYPENAME ordered_vector<Key, Compare, Vector>::CONST_ITERATOR firs
} }
} }
//////////////////////////////////////////////////////////////////// /**
// Function: ordered_vector::r_upper_bound * The recursive implementation of upper_bound().
// Access: Private */
// Description: The recursive implementation of upper_bound().
////////////////////////////////////////////////////////////////////
template<class Key, class Compare, class Vector> template<class Key, class Compare, class Vector>
TYPENAME ordered_vector<Key, Compare, Vector>::CONST_ITERATOR ordered_vector<Key, Compare, Vector>:: TYPENAME ordered_vector<Key, Compare, Vector>::CONST_ITERATOR ordered_vector<Key, Compare, Vector>::
r_upper_bound(TYPENAME ordered_vector<Key, Compare, Vector>::CONST_ITERATOR first, r_upper_bound(TYPENAME ordered_vector<Key, Compare, Vector>::CONST_ITERATOR first,
@ -371,11 +344,9 @@ r_upper_bound(TYPENAME ordered_vector<Key, Compare, Vector>::CONST_ITERATOR firs
} }
} }
//////////////////////////////////////////////////////////////////// /**
// Function: ordered_vector::r_equal_range * The recursive implementation of equal_range().
// Access: Private */
// Description: The recursive implementation of equal_range().
////////////////////////////////////////////////////////////////////
template<class Key, class Compare, class Vector> template<class Key, class Compare, class Vector>
pair<TYPENAME ordered_vector<Key, Compare, Vector>::CONST_ITERATOR, TYPENAME ordered_vector<Key, Compare, Vector>::CONST_ITERATOR> ordered_vector<Key, Compare, Vector>:: pair<TYPENAME ordered_vector<Key, Compare, Vector>::CONST_ITERATOR, TYPENAME ordered_vector<Key, Compare, Vector>::CONST_ITERATOR> ordered_vector<Key, Compare, Vector>::
r_equal_range(TYPENAME ordered_vector<Key, Compare, Vector>::CONST_ITERATOR first, r_equal_range(TYPENAME ordered_vector<Key, Compare, Vector>::CONST_ITERATOR first,

46
pandatool/src/maya/maya_funcs.T
View File

@ -1,24 +1,20 @@
// Filename: maya_funcs.I /**
// Created by: drose (16Feb00) * PANDA 3D SOFTWARE
// * Copyright (c) Carnegie Mellon University. All rights reserved.
//////////////////////////////////////////////////////////////////// *
// * All use of this software is subject to the terms of the revised BSD
// PANDA 3D SOFTWARE * license. You should have received a copy of this license along
// Copyright (c) Carnegie Mellon University. All rights reserved. * with this source code in a file named "LICENSE."
// *
// All use of this software is subject to the terms of the revised BSD * @file maya_funcs.T
// license. You should have received a copy of this license along * @author drose
// with this source code in a file named "LICENSE." * @date 2000-02-16
// */
////////////////////////////////////////////////////////////////////
/**
//////////////////////////////////////////////////////////////////// * A generic function to extract an attribute of some type from an MObject.
// Function: get_maya_attribute * This is used to implement get_bool_attribute(), etc.
// Description: A generic function to extract an attribute of some */
// type from an MObject. This is used to implement
// get_bool_attribute(), etc.
////////////////////////////////////////////////////////////////////
template<class ValueType> template<class ValueType>
bool bool
get_maya_attribute(MObject &node, const string &attribute_name, get_maya_attribute(MObject &node, const string &attribute_name,
@ -33,12 +29,10 @@ get_maya_attribute(MObject &node, const string &attribute_name,
return status; return status;
} }
//////////////////////////////////////////////////////////////////// /**
// Function: set_maya_attribute * A generic function to set an attribute of some type on an MObject. This is
// Description: A generic function to set an attribute of some * used to implement set_bool_attribute(), etc.
// type on an MObject. This is used to implement */
// set_bool_attribute(), etc.
////////////////////////////////////////////////////////////////////
template<class ValueType> template<class ValueType>
bool bool
set_maya_attribute(MObject &node, const string &attribute_name, set_maya_attribute(MObject &node, const string &attribute_name,