Skip to content

Commit 9d3406e

Browse files
committed
Add doxygen comments
1 parent 9db7f57 commit 9d3406e

File tree

1 file changed

+30
-15
lines changed

1 file changed

+30
-15
lines changed

runtime/compiler/optimizer/VectorAPIExpansion.hpp

Lines changed: 30 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -415,51 +415,50 @@ class TR_VectorAPIExpansion : public TR::Optimization
415415
static bool treeTopAllowedWithBoxing(TR::ILOpCodes opCodeValue);
416416

417417
/** \brief
418+
* Identitfies node as non-vectorizable and non-scalarizable
418419
*
419-
*
420+
* \param node
421+
* Node
420422
*
421423
*/
422424
void dontVectorizeNode(TR::Node *node);
423425

424426
/** \brief
425-
* Checks if node will be or already is vectorized. Sets element type, bit length
426-
* and object type if it is.
427-
*
427+
* Checks if node will be or already is vectorized or scalarized.
428+
* Sets element type, bit length, object type, and whether it's scalarized
429+
* if it is.
428430
*
429431
*/
430432
bool isVectorizedOrScalarizedNode(TR::Node *node, TR::DataType &elementType, int32_t &bitsLength,
431433
vapiObjType &objectType, bool &scalarized);
432434

433435

434436
/** \brief
435-
* Creates and caches Vector and Mask classes for the given element type and bit length
437+
* Creates and caches Vector and Mask classes for the given element type and bit length
436438
*
437439
*
438440
*/
439441
void createClassesForBoxing(TR_ResolvedMethod *owningMethod, TR::DataType methodElementType, vec_sz_t bitsLength);
440442

441443
/** \brief
442-
* Depeneding on the checkBoxing parameter checks if boxing of node supported
443-
* or performs boxing
444-
*
445-
*
444+
* Depending on the checkBoxing parameter checks if boxing of node supported
445+
* or performs boxing
446446
*/
447447
void boxChild(TR::TreeTop *treeTop, TR::Node *node, uint32_t i, bool checkBoxing);
448448

449449

450450
/** \brief
451-
* Depeneding on the checkBoxing parameter checks if unboxing of node supported
452-
* or performs unboxing
453-
*
451+
* Depending on the checkBoxing parameter checks if unboxing of node supported
452+
* or performs unboxing
454453
*
455454
*/
456455
TR::Node *unboxNode(TR::Node *parentNode, TR::Node *node, vapiObjType operandObjectType, bool checkBoxing);
457456

458457
/** \brief
459-
* Creates payload symbol reference
460-
*
461-
* \param
458+
* Creates payload symbol reference given TR_OpaqueClassBlock
462459
*
460+
* \param vecClass
461+
* TR_OpaqueClassBlock
463462
*
464463
*/
465464
static TR::SymbolReference *createPayloadSymbolReference(TR::Compilation *comp, TR_OpaqueClassBlock *vecClass);
@@ -693,6 +692,22 @@ class TR_VectorAPIExpansion : public TR::Optimization
693692
*/
694693
static TR_OpaqueClassBlock *getOpaqueClassBlockFromClassNode(TR::Compilation *comp,
695694
TR::Node *classNode);
695+
696+
/** \brief
697+
* Returns TR_OpaqueClassBlock for ann array class given element type
698+
*
699+
* \param comp
700+
* Compilation
701+
*
702+
* \param type
703+
* Data type
704+
*
705+
* \param booleanClass
706+
* true if array of boolean values is needed
707+
*
708+
* \return
709+
* TR_OpaqueClassBlock
710+
*/
696711
static TR_OpaqueClassBlock *getArrayClassFromDataType(TR::Compilation *comp, TR::DataType type, bool booleanClass);
697712

698713
/** \brief

0 commit comments

Comments
 (0)