Doxygen: remove @code when code block not wanted

@code produces a separate code block, rather than just displaying
contents as code.

Mostly replaced use with @c tag when block not wanted.
This commit is contained in:
Dave Hickin
2015-10-15 06:50:26 +01:00
parent 8008823ea5
commit f5df29cf34
6 changed files with 150 additions and 148 deletions

View File

@@ -27,15 +27,15 @@ namespace epics { namespace pvData {
* @brief A vector of bits.
*
* This class implements a vector of bits that grows as needed. Each
* component of the bit set has a {@code bool} value. The
* bits of a {@code BitSet} are indexed by nonnegative integers.
* Individual indexed bits can be examined, set, or cleared. One
* {@code BitSet} may be used to modify the contents of another
* {@code BitSet} through logical AND, logical inclusive OR, and
* logical exclusive OR operations.
* component of the bit set has a @c bool value. The bits of a
* @c BitSet are indexed by nonnegative integers. Individual
* indexed bits can be examined, set, or cleared. One @c BitSet may
* be used to modify the contents of another @c BitSet through
* logical AND, logical inclusive OR, and logical exclusive OR
* operations.
*
* <p>By default, all bits in the set initially have the value
* {@code false}.
* @c false.
*
* <p>Every bit set has a current size, which is the number of bits
* of space currently in use by the bit set. Note that the size is
@@ -43,8 +43,8 @@ namespace epics { namespace pvData {
* implementation. The length of a bit set relates to logical length
* of a bit set and is defined independently of implementation.
*
* <p>A {@code BitSet} is not safe for multithreaded use without
* external synchronization.
* <p>A @c BitSet is not safe for multithreaded use without external
* synchronization.
*
* Based on Java implementation.
*/
@@ -53,14 +53,14 @@ namespace epics { namespace pvData {
POINTER_DEFINITIONS(BitSet);
static BitSetPtr create(uint32 nbits);
/**
* Creates a new bit set. All bits are initially {@code false}.
* Creates a new bit set. All bits are initially @c false.
*/
BitSet();
/**
* Creates a bit set whose initial size is large enough to explicitly
* represent bits with indices in the range {@code 0} through
* {@code nbits-1}. All bits are initially {@code false}.
* represent bits with indices in the range @c 0 through
* @c nbits-1. All bits are initially @c false.
*
* @param nbits the initial size of the bit set
*/
@@ -80,14 +80,14 @@ namespace epics { namespace pvData {
void flip(uint32 bitIndex);
/**
* Sets the bit at the specified index to {@code true}.
* Sets the bit at the specified index to @c true.
*
* @param bitIndex a bit index
*/
void set(uint32 bitIndex);
/**
* Sets the bit specified by the index to {@code false}.
* Sets the bit specified by the index to @c false.
*
* @param bitIndex the index of the bit to be cleared
*/
@@ -103,9 +103,8 @@ namespace epics { namespace pvData {
/**
* Returns the value of the bit with the specified index. The value
* is {@code true} if the bit with the index {@code bitIndex}
* is currently set in this {@code BitSet}; otherwise, the result
* is {@code false}.
* is @c true if the bit with the index @c bitIndex is currently
* set in this @c BitSet; otherwise, the result is @c false.
*
* @param bitIndex the bit index
* @return the value of the bit with the specified index
@@ -113,16 +112,16 @@ namespace epics { namespace pvData {
bool get(uint32 bitIndex) const;
/**
* Sets all of the bits in this BitSet to {@code false}.
* Sets all of the bits in this BitSet to @c false.
*/
void clear();
/**
* Returns the index of the first bit that is set to {@code true}
* that occurs on or after the specified starting index. If no such
* bit exists then {@code -1} is returned.
* Returns the index of the first bit that is set to @c true that
* occurs on or after the specified starting index. If no such bit
* exists then @c -1 is returned.
*
* <p>To iterate over the {@code true} bits in a {@code BitSet},
* <p>To iterate over the @c true bits in a @c BitSet,
* use the following loop:
*
* <pre> {@code
@@ -131,13 +130,13 @@ namespace epics { namespace pvData {
* }}</pre>
*
* @param fromIndex the index to start checking from (inclusive)
* @return the index of the next set bit, or {@code -1} if there
* @return the index of the next set bit, or @c -1 if there
* is no such bit
*/
int32 nextSetBit(uint32 fromIndex) const;
/**
* Returns the index of the first bit that is set to {@code false}
* Returns the index of the first bit that is set to @c false
* that occurs on or after the specified starting index.
*
* @param fromIndex the index to start checking from (inclusive)
@@ -146,23 +145,23 @@ namespace epics { namespace pvData {
int32 nextClearBit(uint32 fromIndex) const;
/**
* Returns true if this {@code BitSet} contains no bits that are set
* to {@code true}.
* Returns true if this @c BitSet contains no bits that are set
* to @c true.
*
* @return indicating whether this {@code BitSet} is empty
* @return indicating whether this @c BitSet is empty
*/
bool isEmpty() const;
/**
* Returns the number of bits set to {@code true} in this {@code BitSet}.
* Returns the number of bits set to @c true in this @c BitSet.
*
* @return the number of bits set to {@code true} in this {@code BitSet}
* @return the number of bits set to @c true in this @c BitSet
*/
uint32 cardinality() const;
/**
* Returns the number of bits of space actually in use by this
* {@code BitSet} to represent bit values.
* @c BitSet to represent bit values.
* The maximum element in the set is the size - 1st element.
*
* @return the number of bits currently in this bit set
@@ -172,9 +171,9 @@ namespace epics { namespace pvData {
/**
* Performs a logical <b>AND</b> of this target bit set with the
* argument bit set. This bit set is modified so that each bit in it
* has the value {@code true} if and only if it both initially
* had the value {@code true} and the corresponding bit in the
* bit set argument also had the value {@code true}.
* has the value @c true if and only if it both initially
* had the value @c true and the corresponding bit in the
* bit set argument also had the value @c true.
*
* @param set a bit set
*/
@@ -183,9 +182,9 @@ namespace epics { namespace pvData {
/**
* Performs a logical <b>OR</b> of this bit set with the bit set
* argument. This bit set is modified so that a bit in it has the
* value {@code true} if and only if it either already had the
* value {@code true} or the corresponding bit in the bit set
* argument has the value {@code true}.
* value @c true if and only if it either already had the
* value @c true or the corresponding bit in the bit set
* argument has the value @c true.
*
* @param set a bit set
*/
@@ -194,13 +193,13 @@ namespace epics { namespace pvData {
/**
* Performs a logical <b>XOR</b> of this bit set with the bit set
* argument. This bit set is modified so that a bit in it has the
* value {@code true} if and only if one of the following
* value @c true if and only if one of the following
* statements holds:
* <ul>
* <li>The bit initially has the value {@code true}, and the
* corresponding bit in the argument has the value {@code false}.
* <li>The bit initially has the value {@code false}, and the
* corresponding bit in the argument has the value {@code true}.
* <li>The bit initially has the value @c true, and the
* corresponding bit in the argument has the value @c false.
* <li>The bit initially has the value @c false, and the
* corresponding bit in the argument has the value @c true.
* </ul>
*
* @param set a bit set

View File

@@ -208,7 +208,7 @@ inline double swap(double val)
/**
* @brief This class implements a Bytebuffer that is like the java.nio.ByteBuffer.
*
* <p>A {@code BitSet} is not safe for multithreaded use without
* <p>A @c BitSet is not safe for multithreaded use without
* external synchronization.
*
* Based on Java implementation.
@@ -373,7 +373,7 @@ public:
template<typename T>
inline void put(std::size_t index, T value);
/**
* Get the new object from the byte buffer. The item MUST have type {@code T}.
* Get the new object from the byte buffer. The item MUST have type @c T.
* The position is adjusted based on the type.
*
* @return The object.
@@ -387,7 +387,7 @@ public:
#endif
/**
* Get the new object from the byte buffer at the specified index.
* The item MUST have type {@code T}.
* The item MUST have type @c T.
* The position is adjusted based on the type.
*
* @param index The location in the byte buffer.
@@ -422,7 +422,7 @@ public:
_position += count;
}
/**
* Put an array of type {@code T} into the byte buffer.
* Put an array of type @c T into the byte buffer.
* The position is adjusted.
*
* @param values The input array.
@@ -431,7 +431,7 @@ public:
template<typename T>
inline void putArray(const T* values, std::size_t count);
/**
* Get an array of type {@code T} from the byte buffer.
* Get an array of type @c T from the byte buffer.
* The position is adjusted.
*
* @param values The destination array.

View File

@@ -63,7 +63,7 @@ namespace epics {
* std::string serialization helper method.
*
* @param[in] value std::string to serialize
* @param[in] offset start of the substring in {@code value}
* @param[in] offset start of the substring in value
* @param[in] count the number of characters to write
* @param[in] buffer serialization buffer
* @param[in] flusher flusher

View File

@@ -906,7 +906,7 @@ public:
/**
* Undefined index.
* Default value upon PVUnion construction. Can be set by the user.
* Corresponds to {@code null} value.
* Corresponds to @c null value.
*/
static int32 UNDEFINED_INDEX;
@@ -917,8 +917,8 @@ public:
UnionConstPtr getUnion() const;
/**
* Get the {@code PVField} value stored in the field.
* @return {@code PVField} value of field, {@code null} if {@code getSelectedIndex() == UNDEFINED_INDEX}.
* Get the @c PVField value stored in the field.
* @return @c PVField value of field, @c null if {@code getSelectedIndex() == UNDEFINED_INDEX}.
*/
PVFieldPtr get() const;
@@ -930,7 +930,7 @@ public:
/**
* Select field (set index) and get the field at the index.
* @param index index of the field to select.
* @return corresponding PVField (of undetermined value), {@code null} if {@code index == UNDEFINED_INDEX}.
* @return corresponding PVField (of undetermined value), @c null if {@code index == UNDEFINED_INDEX}.
* @throws std::invalid_argument if index is invalid (out of range).
*/
PVFieldPtr select(int32 index);
@@ -966,24 +966,27 @@ public:
std::string getSelectedFieldName() const;
/**
* Set the {@code PVField} (by reference!) as selected field.
* If a value is not a valid union field an {@code std::invalid_argument} exception is thrown.
* Set the @c PVField (by reference!) as selected field.
* If a value is not a valid union field an @c std::invalid_argument
* exception is thrown.
* @param value the field to set.
*/
void set(PVFieldPtr const & value);
/**
* Set the {@code PVField} (by reference!) as field at given index.
* If a value is not a valid union field an {@code std::invalid_argument} exception is thrown.
* Use {@code select(int32)} to put by value.
* Set the @c PVField (by reference!) as field at given index.
* If a value is not a valid union field an @c std::invalid_argument
* exception is thrown.
* Use @c select(int32) to put by value.
* @param index index of a field to put.
* @param value the field to set.
* @see #select(int32)
*/
void set(int32 index, PVFieldPtr const & value);
/**
* Set the {@code PVField} (by reference!) as field by given name.
* If a value is not a valid union field an {@code std::invalid_argument} exception is thrown.
* Use {@code select(std::string const &)} to put by value.
* Set the @c PVField (by reference!) as field by given name.
* If a value is not a valid union field an @c std::invalid_argument
* exception is thrown.
* Use @c select(std::string const &) to put by value.
* @param fieldName Name of the field to put.
* @param value the field to set.
* @see #select(std::string const &)

View File

@@ -183,7 +183,7 @@ epicsShareExtern std::ostream& operator<<(std::ostream& o, const Type& type);
*/
enum ScalarType {
/**
* The type is boolean, i.e. value can be {@code false} or {@code true}
* The type is boolean, i.e. value can be @c false or @c true
*/
pvBoolean,
/**
@@ -884,7 +884,7 @@ typedef std::tr1::shared_ptr<FieldBuilder> FieldBuilderPtr;
/**
* @brief Interface for in-line creating of introspection interfaces.
*
* One instance can be used to create multiple {@code Field} instances.
* One instance can be used to create multiple @c Field instances.
* An instance of this object must not be used concurrently (an object has a state).
* @author mse
*/
@@ -895,118 +895,118 @@ public:
/**
* Set ID of an object to be created.
* @param id id to be set.
* @return this instance of a {@code FieldBuilder}.
* @return this instance of a @c FieldBuilder.
*/
FieldBuilderPtr setId(std::string const & id);
/**
* Add a {@code Scalar}.
* Add a @c Scalar.
* @param name name of the array.
* @param scalarType type of a scalar to add.
* @return this instance of a {@code FieldBuilder}.
* @return this instance of a @c FieldBuilder.
*/
FieldBuilderPtr add(std::string const & name, ScalarType scalarType);
/**
* Add a {@code BoundedString}.
* Add a @c BoundedString.
* @param name name of the array.
* @param maxLength a string maximum length.
* @return this instance of a {@code FieldBuilder}.
* @return this instance of a @c FieldBuilder.
*/
FieldBuilderPtr addBoundedString(std::string const & name, std::size_t maxLength);
/**
* Add a {@code Field} (e.g. {@code Structure}, {@code Union}).
* Add a @c Field (e.g. @c Structure, @c Union).
* @param name name of the array.
* @param field a field to add.
* @return this instance of a {@code FieldBuilder}.
* @return this instance of a @c FieldBuilder.
*/
FieldBuilderPtr add(std::string const & name, FieldConstPtr const & field);
/**
* Add variable size array of {@code Scalar} elements.
* Add variable size array of @c Scalar elements.
* @param name name of the array.
* @param scalarType type of a scalar element.
* @return this instance of a {@code FieldBuilder}.
* @return this instance of a @c FieldBuilder.
*/
FieldBuilderPtr addArray(std::string const & name, ScalarType scalarType);
/**
* Add fixed-size array of {@code Scalar} elements.
* Add fixed-size array of @c Scalar elements.
* @param name name of the array.
* @param scalarType type of a scalar element.
* @param size Array fixed size.
* @return this instance of a {@code FieldBuilder}.
* @return this instance of a @c FieldBuilder.
*/
FieldBuilderPtr addFixedArray(std::string const & name, ScalarType scalarType, std::size_t size);
/**
* Add bounded-size array of {@code Scalar} elements.
* Add bounded-size array of @c Scalar elements.
* @param name name of the array.
* @param scalarType type of a scalar element.
* @param bound Array maximum capacity (size).
* @return this instance of a {@code FieldBuilder}.
* @return this instance of a @c FieldBuilder.
*/
FieldBuilderPtr addBoundedArray(std::string const & name, ScalarType scalarType, std::size_t bound);
/**
* Add array of {@code Field} elements.
* Add array of @c Field elements.
* @param name name of the array.
* @param element a type of an array element.
* @return this instance of a {@code FieldBuilder}.
* @return this instance of a @c FieldBuilder.
*/
FieldBuilderPtr addArray(std::string const & name, FieldConstPtr const & element);
/**
* Create a {@code Structure}.
* This resets this instance state and allows new {@code Field} instance to be created.
* @return a new instance of a {@code Structure}.
* Create a @c Structure.
* This resets this instance state and allows new @c Field instance to be created.
* @return a new instance of a @c Structure.
*/
StructureConstPtr createStructure();
/**
* Create an {@code Union}.
* This resets this instance state and allows new {@code Field} instance to be created.
* @return a new instance of an {@code Union}.
* Create an @c Union.
* This resets this instance state and allows new @c Field instance to be created.
* @return a new instance of an @c Union.
*/
UnionConstPtr createUnion();
/**
* Add new nested {@code Structure}.
* {@code endNested()} method must be called
* to complete creation of the nested {@code Structure}.
* Add new nested @c Structure.
* endNested() method must be called
* to complete creation of the nested @c Structure.
* @param name nested structure name.
* @return a new instance of a {@code FieldBuilder} is returned.
* @return a new instance of a @c FieldBuilder is returned.
* @see #endNested()
*/
FieldBuilderPtr addNestedStructure(std::string const & name);
/**
* Add new nested {@code Union}.
* {@code endNested()} method must be called
* to complete creation of the nested {@code Union}.
* Add new nested @c Union.
* endNested() method must be called
* to complete creation of the nested @c Union.
* @param name nested union name.
* @return a new instance of a {@code FieldBuilder} is returned.
* @return a new instance of a @c FieldBuilder is returned.
* @see #endNested()
*/
FieldBuilderPtr addNestedUnion(std::string const & name);
/**
* Add new nested {@code Structure[]}.
* {@code endNested()} method must be called
* to complete creation of the nested {@code Structure}.
* Add new nested @c Structure[].
* endNested() method must be called
* to complete creation of the nested @c Structure.
* @param name nested structure name.
* @return a new instance of a {@code FieldBuilder} is returned.
* @return a new instance of a @c FieldBuilder is returned.
* @see #endNested()
*/
FieldBuilderPtr addNestedStructureArray(std::string const & name);
/**
* Add new nested {@code Union[]}.
* {@code endNested()} method must be called
* to complete creation of the nested {@code Union}.
* Add new nested @c Union[].
* endNested() method must be called
* to complete creation of the nested @c Union.
* @param name nested union name.
* @return a new instance of a {@code FieldBuilder} is returned.
* @return a new instance of a @c FieldBuilder is returned.
* @see #endNested()
*/
FieldBuilderPtr addNestedUnionArray(std::string const & name);
@@ -1015,7 +1015,7 @@ public:
* Complete the creation of a nested object.
* @see #addNestedStructure(std::string const & name)
* @see #addNestedUnion(std::string const & name)
* @return a previous (parent) {@code FieldBuilder}.
* @return a previous (parent) @c FieldBuilder.
*/
FieldBuilderPtr endNested();
@@ -1054,106 +1054,106 @@ class epicsShareClass FieldCreate {
public:
static FieldCreatePtr getFieldCreate();
/**
* Create a new instance of in-line {@code Field} builder.
* @return a new instance of a {@code FieldBuilder}.
* Create a new instance of in-line @c Field builder.
* @return a new instance of a @c FieldBuilder.
*/
FieldBuilderPtr createFieldBuilder() const;
/**
* Create a {@code ScalarField}.
* Create a @c ScalarField.
* @param scalarType The scalar type.
* @return a {@code Scalar} interface for the newly created object.
* @return a @c Scalar interface for the newly created object.
* @throws IllegalArgumentException if an illegal type is specified.
*/
ScalarConstPtr createScalar(ScalarType scalarType) const;
/**
* Create a {@code BoundedString}.
* Create a @c BoundedString.
* @param maxLength a string maximum length.
* @return a {@code BoundedString} interface for the newly created object.
* @return a @c BoundedString interface for the newly created object.
* @throws IllegalArgumentException if maxLength == 0.
*/
BoundedStringConstPtr createBoundedString(std::size_t maxLength) const;
/**
* Create an {@code Array} field, variable size array.
* @param elementType The {@code scalarType} for array elements
* @return An {@code Array} Interface for the newly created object.
* Create an @c Array field, variable size array.
* @param elementType The @c ScalarType for array elements
* @return An @c Array Interface for the newly created object.
*/
ScalarArrayConstPtr createScalarArray(ScalarType elementType) const;
/*
* Create an {@code Array} field, fixed size array.
* @param elementType The {@code scalarType} for array elements
* Create an @c Array field, fixed size array.
* @param elementType The @c ScalarType for array elements
* @param size Fixed array size.
* @return An {@code Array} Interface for the newly created object.
* @return An @c Array Interface for the newly created object.
*/
ScalarArrayConstPtr createFixedScalarArray(ScalarType elementType, std::size_t size) const;
/**
* Create an {@code Array} field, bounded size array.
* @param elementType The {@code scalarType} for array elements
* Create an @c Array field, bounded size array.
* @param elementType The @c ScalarType for array elements
* @param bound Array maximum capacity.
* @return An {@code Array} Interface for the newly created object.
* @return An @c Array Interface for the newly created object.
*/
ScalarArrayConstPtr createBoundedScalarArray(ScalarType elementType, std::size_t bound) const;
/**
* Create an {@code Array} field that is has element type <i>Structure</i>
* @param structure The {@code Structure} for each array element.
* @return An {@code Array} Interface for the newly created object.
* Create an @c Array field that is has element type @c Structure
* @param structure The @c Structure for each array element.
* @return An @c Array Interface for the newly created object.
*/
StructureArrayConstPtr createStructureArray(StructureConstPtr const & structure) const;
/**
* Create a {@code Structure} field.
* @return a {@code Structure} interface for the newly created object.
* Create a @c Structure field.
* @return a @c Structure interface for the newly created object.
*/
StructureConstPtr createStructure () const;
/**
* Create a {@code Structure} field.
* @param fieldNames The array of {@code fieldNames} for the structure.
* @param fields The array of {@code fields} for the structure.
* @return a {@code Structure} interface for the newly created object.
* Create a @c Structure field.
* @param fieldNames the names of the fields for the structure.
* @param fields The array of @c Field objects for the structure.
* @return a @c Structure interface for the newly created object.
*/
StructureConstPtr createStructure (
StringArray const & fieldNames,
FieldConstPtrArray const & fields) const;
/**
* Create a {@code Structure} field with identification string.
* Create a @c Structure field with identification string.
* @param id The identification string for the structure.
* @param fieldNames The array of {@code fieldNames} for the structure.
* @param fields The array of {@code fields} for the structure.
* @return a {@code Structure} interface for the newly created object.
* @param fieldNames the names of the fields for the structure.
* @param fields The array of @c Field objects for the structure.
* @return a @c Structure interface for the newly created object.
*/
StructureConstPtr createStructure (
std::string const & id,
StringArray const & fieldNames,
FieldConstPtrArray const & fields) const;
/**
* Create an {@code Array} field that is has element type <i>Union</i>
* @param punion The {@code Union} for each array element.
* @return An {@code Array} Interface for the newly created object.
* Create an @c Array field that is has element type @c Union
* @param punion The @c Union for each array element.
* @return An @c Array Interface for the newly created object.
*/
UnionArrayConstPtr createUnionArray(UnionConstPtr const & punion) const;
/**
* Create a variant {@code UnionArray} (aka any type) field.
* @return a {@code UnionArray} interface for the newly created object.
* Create a variant @c UnionArray (aka any type) field.
* @return a @c UnionArray interface for the newly created object.
*/
UnionArrayConstPtr createVariantUnionArray() const;
/**
* Create a variant {@code Union} (aka any type) field.
* @return a {@code Union} interface for the newly created object.
* Create a variant @c Union (aka any type) field.
* @return a @c Union interface for the newly created object.
*/
UnionConstPtr createVariantUnion() const;
/**
* Create a {@code Union} field.
* @param fieldNames The array of {@code fieldNames} for the union.
* @param fields The array of {@code fields} for the union.
* @return a {@code Union} interface for the newly created object.
* Create a @c Union field.
* @param fieldNames the names of the fields for the union.
* @param fields The @c Field for each fields for the union.
* @return a @c Union interface for the newly created object.
*/
UnionConstPtr createUnion (
StringArray const & fieldNames,
FieldConstPtrArray const & fields) const;
/**
* Create a {@code Union} field with identification string.
* Create a @c Union field with identification string.
* @param id The identification string for the union.
* @param fieldNames The array of {@code fieldNames} for the union.
* @param fields The array of {@code fields} for the union.
* @return a {@code Union} interface for the newly created object.
* @param fieldNames the names of the fields for the union.
* @param fields The array of @c Field objects for the union.
* @return a @c Union interface for the newly created object.
*/
UnionConstPtr createUnion (
std::string const & id,
@@ -1164,7 +1164,7 @@ public:
* @param structure The structure to which the field is appended.
* @param fieldName The name of the field.
* @param field The field.
* @return a {@code Structure} interface for the newly created object.
* @return a @c Structure interface for the newly created object.
*/
StructureConstPtr appendField(
StructureConstPtr const & structure,
@@ -1174,17 +1174,17 @@ public:
* @param structure The structure to which the fields appended.
* @param fieldNames The names of the fields.
* @param fields The fields.
* @return a {@code Structure} interface for the newly created object.
* @return a @c Structure interface for the newly created object.
*/
StructureConstPtr appendFields(
StructureConstPtr const & structure,
StringArray const & fieldNames,
FieldConstPtrArray const & fields) const;
/**
* Deserialize {@code Field} instance from given byte buffer.
* @param buffer Buffer containing serialized {@code Field} instance.
* Deserialize @c Field instance from given byte buffer.
* @param buffer Buffer containing serialized @c Field instance.
* @param control Deserialization control instance.
* @return a deserialized {@code Field} instance.
* @return a deserialized @c Field instance.
*/
FieldConstPtr deserialize(ByteBuffer* buffer, DeserializableControl* control) const;

View File

@@ -53,7 +53,7 @@ namespace detail {
*/
/**
* boolean, i.e. can only have the values {@code false} or {@code true}
* boolean, i.e. can only have the values @c false or @c true
*/
typedef detail::pick_type<int8_t, signed char,
detail::pick_type<uint8_t, char, unsigned char>::type