diff options
author | Abhyudaya Sharma <sharmaabhyudaya@gmail.com> | 2018-05-18 17:28:25 +0530 |
---|---|---|
committer | Samuel Mehrbrodt <Samuel.Mehrbrodt@cib.de> | 2018-05-22 08:35:22 +0200 |
commit | 038c607e4093d5a26e37d41805def1c5d65ff32d (patch) | |
tree | 354c2a6dd3ef1ca9ca89a1a94ae6c44a9a90f70a | |
parent | d9cc5a1c28a98bc2d4014a14a8e931662e94e037 (diff) |
tdf#108523 Remove @author annotations
Change-Id: Icd9cd2c17657001058f09c4042804a91b4f1d1b1
Reviewed-on: https://gerrit.libreoffice.org/54539
Tested-by: Jenkins <ci@libreoffice.org>
Reviewed-by: Samuel Mehrbrodt <Samuel.Mehrbrodt@cib.de>
-rw-r--r-- | sw/inc/SwNumberTree.hxx | 37 | ||||
-rw-r--r-- | sw/inc/accmap.hxx | 18 | ||||
-rw-r--r-- | sw/inc/anchoredobject.hxx | 84 | ||||
-rw-r--r-- | sw/inc/dcontact.hxx | 16 | ||||
-rw-r--r-- | sw/inc/docfunc.hxx | 6 | ||||
-rw-r--r-- | sw/inc/fesh.hxx | 4 | ||||
-rw-r--r-- | sw/inc/fmtcolfunc.hxx | 8 | ||||
-rw-r--r-- | sw/inc/format.hxx | 2 | ||||
-rw-r--r-- | sw/inc/frmfmt.hxx | 4 | ||||
-rw-r--r-- | sw/inc/numrule.hxx | 27 |
10 files changed, 25 insertions, 181 deletions
diff --git a/sw/inc/SwNumberTree.hxx b/sw/inc/SwNumberTree.hxx index 960d89335b0d..2472f160f95d 100644 --- a/sw/inc/SwNumberTree.hxx +++ b/sw/inc/SwNumberTree.hxx @@ -228,8 +228,6 @@ public: /** set level of this node precondition: node is already member of a list tree - - @author OD */ void SetLevelInListTree( const int nLevel ); @@ -286,14 +284,10 @@ public: */ void ValidateMe(); - /** - Notifies all invalid siblings of this node. - */ + /** Notifies all invalid siblings of this node. */ void NotifyInvalidSiblings(); - /** - notification of all nodes in the list tree on certain list level - */ + /** notification of all nodes in the list tree on certain list level */ void NotifyNodesOnListLevel( const int nListLevel ); /** Invalidation and notification of complete numbering tree @@ -325,8 +319,6 @@ public: The search for the preceding node is performed for the tree below the <this> node. To search the complete tree, the method has been called for the root of the tree. - - @author OD */ const SwNumberTreeNode* GetPrecedingNodeOf( const SwNumberTreeNode& rNode ) const; @@ -343,9 +335,7 @@ public: #endif // DBG_UTIL protected: - /** - the children - */ + /** the children */ tSwNumberTreeChildren mChildren; /** @@ -392,14 +382,10 @@ protected: void IsSane(bool bRecursive, std::vector<const SwNumberTreeNode *> rParents) const; #endif // DBG_UTIL - /** - the parent node - */ + /** he parent node */ SwNumberTreeNode * mpParent; - /** - the number of the node - */ + /** the number of the node */ mutable SwNumberTree::tSwNumTreeNumber mnNumber; // boolean indicating, that a node of a not counted parent node is continuing @@ -486,15 +472,10 @@ protected: */ virtual void NotifyNode() = 0; - /** - Notifies this node (NotifyNode) and all descendants. - */ + /** Notifies this node (NotifyNode) and all descendants.*/ void Notify(); - /** notification of children nodes on certain depth - - @author OD - */ + /** notification of children nodes on certain depth */ void NotifyChildrenOnDepth( const int nDepth ); /** @@ -564,9 +545,7 @@ protected: */ virtual bool IsCountPhantoms() const = 0; - /** - Return if all descendants of this node are phantoms. - */ + /** Return if all descendants of this node are phantoms. */ bool HasOnlyPhantoms() const; bool HasPhantomCountedParent() const; diff --git a/sw/inc/accmap.hxx b/sw/inc/accmap.hxx index 12ccb97b7111..fc7f665da383 100644 --- a/sw/inc/accmap.hxx +++ b/sw/inc/accmap.hxx @@ -134,8 +134,6 @@ class SwAccessibleMap : public ::accessibility::IAccessibleViewForwarder, which have a selection Important note: method has to used inside a mutual exclusive section - - @author OD */ SwAccessibleSelectedParas_Impl* BuildSelectedParas(); @@ -184,8 +182,6 @@ public: /** get size of a dedicated preview page - @author OD - @param _nPreviewPageNum input parameter - physical page number of page visible in the page preview @@ -225,8 +221,6 @@ public: /** invalidation CONTENT_FLOWS_FROM/_TO relation of a paragraph - @author OD - @param _rTextFrame input parameter - reference to paragraph, whose CONTENT_FLOWS_FROM/_TO has to be invalidated. @@ -238,16 +232,10 @@ public: void InvalidateParaFlowRelation( const SwTextFrame& _rTextFrame, const bool _bFrom ); - /** invalidation of text selection of a paragraph - - @author OD - */ + /** invalidation of text selection of a paragraph */ void InvalidateParaTextSelection( const SwTextFrame& _rTextFrame ); - /** invalidation of text selection of all paragraphs - - @author OD - */ + /** invalidation of text selection of all paragraphs */ void InvalidateTextSelectionOfAllParas(); sal_Int32 GetChildIndex( const SwFrame& rParentFrame, @@ -299,8 +287,6 @@ private: output device for mapping logic document positions to page preview window positions and vice versa and doesn't take care to recover its changes. - @author OD - @param _rPoint input parameter - constant reference to point to determine the mapping mode adjustments for page/print preview. diff --git a/sw/inc/anchoredobject.hxx b/sw/inc/anchoredobject.hxx index 1999354deb79..a44c4e23bcb2 100644 --- a/sw/inc/anchoredobject.hxx +++ b/sw/inc/anchoredobject.hxx @@ -39,8 +39,6 @@ enum class RndStdIds; Purpose of this class is to provide a unified interface for the positioning of Writer fly frames (derived classes of <SwFlyFrame>) and of drawing objects (derived classes of <SwAnchoredDrawObject>). - - @author OD */ class SW_DLLPUBLIC SwAnchoredObject { @@ -116,8 +114,6 @@ class SW_DLLPUBLIC SwAnchoredObject /** method to indicate, that positioning of anchored object is in progress note: method is implemented empty - - @author OD */ friend class SwObjPositioningInProgress; void SetPositioningInProgress( const bool _bPosInProgress ) @@ -133,8 +129,6 @@ class SW_DLLPUBLIC SwAnchoredObject positioning, it's decided, if the Writer fly frame has to be invalidated. improvement - add second parameter <_rAnchorCharFrame> - @author OD - @param _rAnch input parameter - reference to anchor position @@ -152,8 +146,6 @@ class SW_DLLPUBLIC SwAnchoredObject is updated. This is checked for change and depending on the applied positioning, it's decided, if the Writer fly frame has to be invalidated. - @author OD - @param _rAnch input parameter - reference to anchor position @@ -177,28 +169,19 @@ class SW_DLLPUBLIC SwAnchoredObject /** method to assure that anchored object is registered at the correct page frame - - @author OD */ virtual void RegisterAtCorrectPage() = 0; - /** method to indicate, that anchored object is attached to a anchor frame - - @author OD - */ + /** method to indicate, that anchored object is attached to a anchor frame */ virtual void ObjectAttachedToAnchorFrame(); /** method to determine, if other anchored objects, also attached at to the anchor frame, have to consider its wrap influence. - - @author OD */ bool ConsiderObjWrapInfluenceOfOtherObjs() const; /** method to apply temporary consideration of wrapping style influence to the anchored objects, which are anchored at the same anchor frame - - @author OD */ void SetTmpConsiderWrapInfluenceOfOtherObjs(); @@ -225,8 +208,6 @@ class SW_DLLPUBLIC SwAnchoredObject for an at-page, at-frame or at-paragraph anchored object and the anchor character frame for an at-character and as-character anchored object. - - @author OD */ SwFrame* GetAnchorFrameContainingAnchPos(); @@ -242,8 +223,6 @@ class SW_DLLPUBLIC SwAnchoredObject can be found. Thus, the return type changed to be a pointer and can be NULL. - @author OD - @param _rAnchoredObj input parameter - anchored object, for which the page frame of its 'anchor' has to be determined. @@ -256,8 +235,6 @@ class SW_DLLPUBLIC SwAnchoredObject /** get frame, which contains the anchor character, if the object is anchored at-character or as-character. - @author OD - @return SwTextFrame* text frame containing the anchor character. It's NULL, if the object isn't anchored at-character resp. as-character. @@ -280,8 +257,6 @@ class SW_DLLPUBLIC SwAnchoredObject depending on the applied positioning, it's decided, if the Writer fly frame has to be invalidated. - @author OD - @param _bCheckForParaPorInf input parameter - boolean indicating, if check on paragraph portion information has to be done. @@ -299,52 +274,33 @@ class SW_DLLPUBLIC SwAnchoredObject SwTwips GetLastTopOfLine() const { return mnLastTopOfLine;} void AddLastTopOfLineY( SwTwips _nDiff ); - /** reset members <maLastCharRect> and <mnLastTopOfLine> - - @author OD - */ + /** reset members <maLastCharRect> and <mnLastTopOfLine> */ void ClearCharRectAndTopOfLine(); /** method to determine position for the object and set the position at the object - - @author OD */ virtual void MakeObjPos() = 0; - /** is positioning of anchored object in progress - - @author OD - */ + /** is positioning of anchored object in progress */ bool IsPositioningInProgress() const { return mbPositioningInProgress; } - /** method to determine, if invalidation of position is allowed - - @author OD - */ + /** method to determine, if invalidation of position is allowed */ bool InvalidationOfPosAllowed() const; - /** method to invalidate position of the anchored object - - @author OD - */ + /** method to invalidate position of the anchored object */ virtual void InvalidateObjPos() = 0; /** method to perform necessary invalidations for the positioning of objects, for whose the wrapping style influence has to be considered on the object positioning. - - @author OD */ void InvalidateObjPosForConsiderWrapInfluence(); - /** method to trigger notification of 'background' - - @author OD - */ + /** method to trigger notification of 'background' */ virtual void NotifyBackground( SwPageFrame* _pPageFrame, const SwRect& _rRect, PrepareHint _eHint ) = 0; @@ -369,15 +325,10 @@ class SW_DLLPUBLIC SwAnchoredObject method has typically to be called, if the anchored object gets its anchor frame assigned and if the anchor frame changes its layout direction - - @author OD */ virtual void UpdateLayoutDir(); - /** method to determine object area inclusive its spacing - - @author OD - */ + /** method to determine object area inclusive its spacing */ const SwRect& GetObjRectWithSpaces() const; void InvalidateObjRectWithSpaces() const @@ -390,8 +341,6 @@ class SW_DLLPUBLIC SwAnchoredObject Note: result of this method also decides, if the boolean for the layout process are of relevance. - - @author OD */ bool ConsiderObjWrapInfluenceOnObjPos() const; @@ -436,8 +385,6 @@ class SW_DLLPUBLIC SwAnchoredObject /** method to determine, if due to anchored object size and wrapping style, its layout environment is cleared. - - @author OD */ bool HasClearedEnvironment() const; @@ -450,8 +397,6 @@ class SW_DLLPUBLIC SwAnchoredObject on object positioning' is ON, additionally all anchored objects at the anchor frame and all following anchored objects on the page frame are invalidated. - - @author OD */ void UpdateObjInSortedList(); @@ -459,8 +404,6 @@ class SW_DLLPUBLIC SwAnchoredObject A format isn't possible, if anchored object is in an invisible layer. Note: method is virtual to refine the conditions for the sub-classes. - - @author OD */ virtual bool IsFormatPossible() const; @@ -475,8 +418,6 @@ class SW_DLLPUBLIC SwAnchoredObject with a column, which is a previous one of the column its anchor frame is in. Only applied for at-paragraph and at-character anchored objects. - - @author OD */ bool OverlapsPrevColumn() const; @@ -485,8 +426,6 @@ class SW_DLLPUBLIC SwAnchoredObject Usage: Needed layout information for WW8 export - @author OD - @return Point - determined relative position */ Point GetRelPosToAnchorFrame() const; @@ -500,8 +439,6 @@ class SW_DLLPUBLIC SwAnchoredObject the position relative to the table cell is determined. Output parameter <_obRelToTableCell> reflects this situation - @author OD - @param _bFollowTextFlow input parameter - boolean indicating, if the anchored object has to follow the text flow. @@ -520,8 +457,6 @@ class SW_DLLPUBLIC SwAnchoredObject Usage: Needed layout information for WW8 export - @author OD - @return Point - determined relative position */ Point GetRelPosToChar() const; @@ -531,8 +466,6 @@ class SW_DLLPUBLIC SwAnchoredObject Usage: Needed layout information for WW8 export - @author OD - @return Point - determined relative position */ Point GetRelPosToLine() const; @@ -542,8 +475,7 @@ class SW_DLLPUBLIC SwAnchoredObject */ virtual void dumpAsXml( xmlTextWriterPtr pWriter ) const; - /** The element name to show in the XML dump. - */ + /** The element name to show in the XML dump. */ virtual const char* getElementName( ) const { return "SwAnchoredObject"; } }; diff --git a/sw/inc/dcontact.hxx b/sw/inc/dcontact.hxx index 544e55973526..470132a0ee44 100644 --- a/sw/inc/dcontact.hxx +++ b/sw/inc/dcontact.hxx @@ -83,8 +83,6 @@ class SW_DLLPUBLIC SwContact : public SdrObjUserCall, public SwClient <SdrObjGroup::SetLayer(..)|NbcSetLayer(..)> sets also the layer of the members. - @author OD - @param _bToVisible input parameter - boolean indicating, if object has to be moved to visible (== true) or invisible (== false) layer. @@ -122,8 +120,6 @@ public: uses method <MoveObjToLayer(..)> - @author OD - @param _pDrawObj drawing object, which will be moved to the visible layer */ @@ -133,8 +129,6 @@ public: uses method <MoveObjToLayer(..)> - @author OD - @param _pDrawObj drawing object, which will be moved to the visible layer */ @@ -164,9 +158,7 @@ public: const SwIndex& GetContentAnchorIndex() const; - /** get data collection of anchored objects, handled by with contact - - */ + /** get data collection of anchored objects, handled by with contact */ virtual void GetAnchoredObjs( std::vector<SwAnchoredObject*>& _roAnchoredObjs ) const = 0; /** get minimum order number of anchored objects handled by with contact @@ -212,8 +204,7 @@ public: virtual void MoveObjToVisibleLayer( SdrObject* _pDrawObj ) override; virtual void MoveObjToInvisibleLayer( SdrObject* _pDrawObj ) override; - /** get data collection of anchored objects handled by with contact - */ + /** get data collection of anchored objects handled by with contact */ virtual void GetAnchoredObjs( std::vector<SwAnchoredObject*>& _roAnchoredObjs ) const override; }; @@ -415,8 +406,7 @@ class SwDrawContact final : public SwContact void NotifyBackgrdOfAllVirtObjs( const tools::Rectangle* pOldBoundRect ); - /** get data collection of anchored objects, handled by with contact - */ + /** get data collection of anchored objects, handled by with contact */ static void GetTextObjectsFromFormat( std::list<SdrTextObj*>&, SwDoc* ); virtual void GetAnchoredObjs( std::vector<SwAnchoredObject*>& _roAnchoredObjs ) const override; diff --git a/sw/inc/docfunc.hxx b/sw/inc/docfunc.hxx index d4d1256ccc2f..cd645ea570cc 100644 --- a/sw/inc/docfunc.hxx +++ b/sw/inc/docfunc.hxx @@ -26,8 +26,6 @@ namespace docfunc { /** method to check, if given Writer document contains at least one drawing object - @author OD - @param p_rDoc input parameter - reference to the Writer document, which is investigated. */ @@ -36,8 +34,6 @@ namespace docfunc /** method to check, if given Writer document contains only drawing objects, which are completely on its page. - @author OD - @param p_rDoc input parameter - reference to the Writer document, which is investigated. */ @@ -52,8 +48,6 @@ namespace docfunc a list style from its parent paragraphs style. This information is needed for the OpenDocument file format export. - @author OD - @param rDoc input parameter - reference to the text document, which is investigated. diff --git a/sw/inc/fesh.hxx b/sw/inc/fesh.hxx index b84ce9310fb8..efc5325e898b 100644 --- a/sw/inc/fesh.hxx +++ b/sw/inc/fesh.hxx @@ -779,8 +779,6 @@ public: color COL_BLACK (default color on constructing object of class Color) is returned. - @author OD - @returns an object of class Color */ const Color GetShapeBackgrd() const; @@ -791,8 +789,6 @@ public: horizontal text direction of a drawing object is given by the corresponding page property. - @author OD - @returns boolean, indicating, if the horizontal text direction of the page, the selected drawing object is on, is right-to-left. */ diff --git a/sw/inc/fmtcolfunc.hxx b/sw/inc/fmtcolfunc.hxx index ed7162f7968e..12c382858293 100644 --- a/sw/inc/fmtcolfunc.hxx +++ b/sw/inc/fmtcolfunc.hxx @@ -33,8 +33,6 @@ namespace TextFormatCollFunc The assignment of a paragraph style to a list level of the outline style has to be deleted, if the numbering rule, which is set at the paragraph style isn't the outline style. - - @author OD */ void CheckTextFormatCollForDeletionOfAssignmentToOutlineStyle( SwFormat* pFormat, @@ -42,8 +40,6 @@ namespace TextFormatCollFunc /** determines the list style, which directly set at the given paragraph style - @author OD - @param rTextFormatColl input parameter - paragraph style for which the list style should be retrieved @@ -58,8 +54,6 @@ namespace TextFormatCollFunc @param rTextFormatColl input parameter - paragraph style which is added to its directly set list style - - @author OD */ void AddToNumRule( SwTextFormatColl& rTextFormatColl ); @@ -69,8 +63,6 @@ namespace TextFormatCollFunc @param rTextFormatColl input parameter - paragraph style which is removed from its directly set list style - - @author OD */ void RemoveFromNumRule( SwTextFormatColl& rTextFormatColl ); } diff --git a/sw/inc/format.hxx b/sw/inc/format.hxx index a739fddf18a3..870cfff0367e 100644 --- a/sw/inc/format.hxx +++ b/sw/inc/format.hxx @@ -243,8 +243,6 @@ public: Default implementation returns false. Thus, subclasses have to override method, if the specific subclass can have a transparent background. - @author OD - @return false, default implementation */ virtual bool IsBackgroundTransparent() const; diff --git a/sw/inc/frmfmt.hxx b/sw/inc/frmfmt.hxx index a8f61f3cf17a..6b117cf74616 100644 --- a/sw/inc/frmfmt.hxx +++ b/sw/inc/frmfmt.hxx @@ -221,8 +221,6 @@ public: because format of fly frame provides transparent backgrounds. Method determines, if background of fly frame is transparent. - @author OD - @return true, if background color is transparent, but not "no fill" or a existing background graphic is transparent. */ @@ -235,8 +233,6 @@ public: This is the case, if no background graphic is set and the background color is "no fill"/"auto fill" - @author OD - @return true, if background brush is "inherited" from parent/grandparent */ bool IsBackgroundBrushInherited() const; diff --git a/sw/inc/numrule.hxx b/sw/inc/numrule.hxx index fe6476a93fde..7d9da21ad0f7 100644 --- a/sw/inc/numrule.hxx +++ b/sw/inc/numrule.hxx @@ -173,10 +173,7 @@ public: const bool bInclSuperiorNumLabels, const int nRestrictInclToThisLevel ) const; - /** - - @return list of associated text nodes - */ + /** @return list of associated text nodes */ void GetTextNodeList( SwNumRule::tTextNodeList& rTextNodeList ) const; SwNumRule::tTextNodeList::size_type GetTextNodeListSize() const; @@ -274,44 +271,28 @@ public: /// namespace for static functions and methods for numbering and bullets namespace numfunc { - /** retrieve font family name used for the default bullet list characters - - @author OD - */ + /** retrieve font family name used for the default bullet list characters */ OUString const & GetDefBulletFontname(); /** determine if default bullet font is user defined The default bullet font is user defined, if it is given in the user configuration - - @author OD */ bool IsDefBulletFontUserDefined(); - /** retrieve font used for the default bullet list characters - - @author OD - */ + /** retrieve font used for the default bullet list characters */ SW_DLLPUBLIC const vcl::Font& GetDefBulletFont(); - /** retrieve unicode of character used for the default bullet list for the given list level - - @author OD - */ + /** retrieve unicode of character used for the default bullet list for the given list level */ sal_Unicode GetBulletChar( sal_uInt8 nLevel ); /** configuration, if at first position of the first list item the <TAB>-key increased the indent of the complete list or only demotes this list item. The same for <SHIFT-TAB>-key at the same position for decreasing the indent of the complete list or only promotes this list item. - - @author OD */ bool ChangeIndentOnTabAtFirstPosOfFirstListItem(); - /** - @author OD - */ SvxNumberFormat::SvxNumPositionAndSpaceMode GetDefaultPositionAndSpaceMode(); } |