Commit ec2fbe67 authored by Sven Buijssen's avatar Sven Buijssen Committed by David Partyka
Browse files

DOC: Avoid having the string "BTX" show up in the HTML documentation

parent d2eead14
......@@ -35,10 +35,10 @@ public:
vtkInformationDataObjectKey(const char* name, const char* location);
~vtkInformationDataObjectKey();
//BTX
// Description:
// Get/Set the value associated with this key in the given
// information object.
//BTX
void Set(vtkInformation* info, vtkDataObject*);
vtkDataObject* Get(vtkInformation* info);
//ETX
......
......@@ -110,6 +110,7 @@ public:
{vtkObject::SetGlobalWarningDisplay(0);};
static int GetGlobalWarningDisplay();
//BTX
// Description:
// Allow people to add/remove/invoke observers (callbacks) to any VTK
// object. This is an implementation of the subject/observer design
......@@ -121,7 +122,6 @@ public:
// priority commands are called first. A command may set an abort
// flag to stop processing of the event. (See vtkCommand.h for more
// information.)
//BTX
unsigned long AddObserver(unsigned long event, vtkCommand *,
float priority=0.0f);
unsigned long AddObserver(const char *event, vtkCommand *,
......@@ -188,11 +188,11 @@ public:
}
//ETX
//BTX
// Description:
// This method invokes an event and return whether the event was
// aborted or not. If the event was aborted, the return value is 1,
// otherwise it is 0.
//BTX
int InvokeEvent(unsigned long event, void *callData);
int InvokeEvent(const char *event, void *callData);
//ETX
......@@ -211,6 +211,7 @@ protected:
vtkTimeStamp MTime; // Keep track of modification time
vtkSubjectHelper *SubjectHelper; // List of observers on this object
//BTX
// Description:
// These methods allow a command to exclusively grab all events. (This
// method is typically used by widgets to grab events once an event
......@@ -218,7 +219,6 @@ protected:
// public methods found in the class vtkInteractorObserver. Note that
// these methods are designed to support vtkInteractorObservers since
// they use two separate vtkCommands to watch for mouse and keypress events.
//BTX
void InternalGrabFocus(vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL);
void InternalReleaseFocus();
//ETX
......
......@@ -67,12 +67,12 @@ public:
// index like a point id or cell id.
void Insert(double priority, vtkIdType id);
//BTX
// Description:
// Removes item at specified location from tree; then reorders and
// balances tree. The location == 0 is the root of the tree. If queue
// is exhausted, then a value < 0 is returned. (Note: the location
// is not the same as deleting an id; id is mapped to location.)
//BTX
vtkIdType Pop(vtkIdType location, double &priority);
//ETX
......@@ -81,10 +81,10 @@ public:
// languages.
vtkIdType Pop(vtkIdType location=0);
//BTX
// Description:
// Peek into the queue without actually removing anything. Returns the
// id and the priority.
//BTX
vtkIdType Peek(vtkIdType location, double &priority);
//ETX
......
......@@ -97,11 +97,11 @@ public:
void SetDisplayLocationToForeground()
{this->DisplayLocation = VTK_FOREGROUND_LOCATION;};
//BTX
// Description:
// Have the device specific subclass render this property.
//BTX
virtual void Render (vtkViewport* vtkNotUsed(viewport)) {}
//ETX
//ETX
protected:
vtkProperty2D();
......
......@@ -133,10 +133,10 @@ public:
// Get the data at a particular index.
vtkStdString &GetValue(vtkIdType id);
//BTX
// Description:
// Set the data at a particular index. Does not do range checking. Make sure
// you use the method SetNumberOfValues() before inserting data.
//BTX
void SetValue(vtkIdType id, vtkStdString value)
{ this->Array[id] = value; this->DataChanged(); }
//ETX
......@@ -159,9 +159,9 @@ public:
int GetNumberOfElementComponents() { return 0; }
int GetElementComponentSize() { return static_cast<int>(sizeof(vtkStdString::value_type)); }
//BTX
// Description:
// Insert data at a specified position in the array.
//BTX
void InsertValue(vtkIdType id, vtkStdString f);
//ETX
void InsertValue(vtkIdType id, const char *val);
......@@ -171,9 +171,9 @@ public:
// Insert a value into the array from a variant.
void SetVariantValue(vtkIdType idx, vtkVariant value);
//BTX
// Description:
// Insert data at the end of the array. Return its location in the array.
//BTX
vtkIdType InsertNextValue(vtkStdString f);
//ETX
vtkIdType InsertNextValue(const char *f);
......
......@@ -677,9 +677,9 @@ protected:
// Builds a mapping from edge id to source/target vertex id.
void BuildEdgeList();
//BTX
// Description:
// Friend iterator classes.
//BTX
friend class vtkAdjacentVertexIterator;
friend class vtkEdgeListIterator;
friend class vtkInEdgeIterator;
......
......@@ -104,6 +104,7 @@ public:
// the delays associated with returning the vertex index.
vtkIdType AddVertex(const vtkVariant& pedigreeId);
//BTX
// Description:
// Adds a directed edge from \p u to \p v,
// where \p u and \p v are vertex indices,
......@@ -111,10 +112,10 @@ public:
//
// \p vtkEdgeType contains fields for \p Source vertex index,
// \p Target vertex index, and edge index \p Id.
//BTX
vtkEdgeType AddEdge(vtkIdType u, vtkIdType v);
//ETX
//BTX
// Description:
// Adds a directed edge from \p u to \p v,
// where \p u and \p v are vertex indices,
......@@ -126,7 +127,6 @@ public:
//
// \p vtkEdgeType contains fields for \p Source vertex index,
// \p Target vertex index, and edge index \p Id.
//BTX
vtkEdgeType AddEdge(vtkIdType u, vtkIdType v,
vtkVariantArray *propertyArr);
//ETX
......
......@@ -74,10 +74,10 @@ public:
double yMax, double zMin, double zMax);
void GetDataBounds(double *b) const;
//BTX
// Description:
// Get a pointer to the 3 bound minima (xmin, ymin and zmin) or the
// 3 bound maxima (xmax, ymax, zmax). Don't free this pointer.
//BTX
vtkGetMacro(MinBounds, double*);
vtkGetMacro(MaxBounds, double*);
//ETX
......@@ -100,10 +100,10 @@ public:
this->MaxBounds[2] = maxBounds[2];
}
//BTX
// Description:
// Get a pointer to the 3 data bound minima (xmin, ymin and zmin) or the
// 3 data bound maxima (xmax, ymax, zmax). Don't free this pointer.
//BTX
vtkGetMacro(MinDataBounds, double*);
vtkGetMacro(MaxDataBounds, double*);
//ETX
......
......@@ -405,6 +405,7 @@ public:
static vtkPolyData* GetData(vtkInformationVector* v, int i=0);
//ETX
//BTX
// Description:
// Scalar field critical point classification (for manifold 2D meshes).
// Reference: J. Milnor "Morse Theory", Princeton University Press, 1963.
......@@ -422,7 +423,6 @@ public:
// vtkPolyData::ERR_INCORRECT_FIELD: the number of entries in the scalar field
// array is different form the number of vertices in the mesh.
// vtkPolyData::ERR_NO_SUCH_FIELD: the specified scalar field does not exist.
//BTX
enum
{
ERR_NO_SUCH_FIELD = -4,
......@@ -433,7 +433,7 @@ public:
SADDLE = 1,
MAXIMUM = 2
};
//ETX
//ETX
int GetScalarFieldCriticalIndex (vtkIdType pointId,
vtkDataArray *scalarField);
int GetScalarFieldCriticalIndex (vtkIdType pointId, int fieldId);
......
......@@ -60,17 +60,17 @@ public:
// Key to store the additional information for an update request
static vtkInformationObjectBaseKey* EXTRA_INFORMATION();
//BTX
// Description:
// Definition of different types of processing units an algorithm
// can be executed
//BTX
enum
{
PROCESSING_UNIT_NONE = 0,
PROCESSING_UNIT_CPU = 1,
PROCESSING_UNIT_GPU = 2
};
//ETX
//ETX
// Description:
// Enable/Disable Multi-Threaded updating mechanism
......
......@@ -82,9 +82,9 @@ public:
// Get the parent of a vertex.
vtkIdType GetParent(vtkIdType v);
//BTX
// Description:
// Get the edge connecting the vertex to its parent.
//BTX
vtkEdgeType GetParentEdge(vtkIdType v);
//ETX
......
......@@ -50,13 +50,13 @@ public:
vtkTypeMacro(vtkAppendCompositeDataLeaves,vtkCompositeDataSetAlgorithm);
void PrintSelf( ostream& os, vtkIndent indent );
//BTX
// Description:
// Get any input of this filter.
//BTX
vtkCompositeDataSet* GetInput( int idx );
vtkCompositeDataSet* GetInput()
{ return this->GetInput( 0 ); }
//ETX
//ETX
// Description:
// Remove a dataset from the list of data to append.
......
......@@ -39,9 +39,9 @@ public:
vtkTypeMacro(vtkAppendFilter,vtkUnstructuredGridAlgorithm);
void PrintSelf(ostream& os, vtkIndent indent);
//BTX
// Description:
// Get any input of this filter.
//BTX
vtkDataSet *GetInput(int idx);
vtkDataSet *GetInput()
{return this->GetInput( 0 );}
......
......@@ -62,9 +62,9 @@ public:
// used when UserManagedInputs is true, use SetInputByNumber (NULL) instead.
void RemoveInput(vtkPolyData *);
//BTX
// Description:
// Get any input of this filter.
//BTX
vtkPolyData *GetInput(int idx);
vtkPolyData *GetInput() { return this->GetInput( 0 ); };
//ETX
......
......@@ -57,9 +57,9 @@ public:
// used when UserManagedInputs is true, use SetInputByNumber (NULL) instead.
void RemoveInput(vtkSelection *);
//BTX
// Description:
// Get any input of this filter.
//BTX
vtkSelection *GetInput(int idx);
vtkSelection *GetInput() { return this->GetInput( 0 ); };
//ETX
......
......@@ -81,10 +81,10 @@ public:
// the random seed provided by Gnu R based on the current time.
void SetRandGenSeed(const int seed);
//BTX
// Description:
// Available statistical distribution output types. Depending on the distribution type, up to three
// parameters (param1, param2, param3) must be specified when using SetStatisticalDistributionForColumn().
//BTX
typedef enum
{
......
......@@ -136,12 +136,12 @@ public:
virtual void SetFileId( int f );
int GetFileId();
//BTX
// Description:
// Extra cell data array that can be generated. By default, this array
// is off. The value of the array is the integer global id of the cell.
// The name of the array is returned by GetGlobalElementIdArrayName()
// ***NOTE*** No more "unique" global ID. Instead we have an arbitrary number of maps.
//BTX
enum {
SEARCH_TYPE_ELEMENT=0,
SEARCH_TYPE_NODE,
......
......@@ -403,9 +403,9 @@ protected:
char *XRayTubeCurrent;
double DirectionCosine[6];
//BTX
// Description:
// PIMPL Encapsulation for STL containers
//BTX
vtkMedicalImagePropertiesInternals *Internals;
//ETX
......
......@@ -98,6 +98,7 @@ public:
// Return the database associated with the query.
vtkGetObjectMacro(Database, vtkSQLDatabase);
//BTX
// Description:
// Bind a parameter to a placeholder in a query. A full discussion
// of this feature is beyond the scope of this header file, but in
......@@ -126,7 +127,6 @@ public:
// vtkVariant) dispatches to one of the more type-specific versions. It
// should be OK to use in database drivers without modification.
//BTX
virtual bool BindParameter(int index, unsigned char value);
virtual bool BindParameter(int index, unsigned short value);
virtual bool BindParameter(int index, unsigned int value);
......@@ -164,6 +164,7 @@ public:
// Reset all parameter bindings to NULL.
virtual bool ClearParameterBindings();
//BTX
// Description:
// Escape a string for inclusion into an SQL query.
// If \a addSurroundingQuotes is true, then quotation marks appropriate to the
......@@ -173,7 +174,6 @@ public:
// A default, simple-minded implementation is provided for
// database backends that do not provde a way to escape
// strings for use inside queries.
//BTX
virtual vtkStdString EscapeString( vtkStdString s, bool addSurroundingQuotes = true );
//ETX
......
......@@ -74,6 +74,7 @@ public:
vtkIndent *indent = 0);
//ETX
//BTX
// Description:
// Read a vtkXMLDataElement from a stream, string or file.
// The 'encoding' parameter will be used to set the internal encoding of the
......@@ -84,7 +85,6 @@ public:
// Return the root element on success, NULL otherwise.
// Note that you have to call Delete() on the element returned by that
// function to ensure it is freed properly.
//BTX
static vtkXMLDataElement* ReadElementFromStream(
istream&, int encoding = VTK_ENCODING_NONE);
static vtkXMLDataElement* ReadElementFromString(
......@@ -105,6 +105,7 @@ public:
const char** atts,
int encoding);
//BTX
// Description:
// Find all elements in 'tree' that are similar to 'elem' (using the
// vtkXMLDataElement::IsEqualTo() predicate).
......@@ -112,7 +113,6 @@ public:
// 'results' (automatically allocated).
// Warning: the results do not include 'elem' if it was found in the tree ;
// do not forget to deallocate 'results' if something was found.
//BTX
static int FindSimilarElements(vtkXMLDataElement *elem,
vtkXMLDataElement *tree,
vtkXMLDataElement ***results);
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment