diff options
| author | Alaa.Bukhari <alloo.bukhari@gmail.com> | 2013-07-04 14:06:25 +0300 |
|---|---|---|
| committer | Fridrich Strba <fridrich@documentfoundation.org> | 2013-07-04 12:37:06 +0000 |
| commit | 3aea5e4c50d0b84e4e410856696eb0bf9101fbba (patch) | |
| tree | c48801330cdd15c83853260c9abd20c1b94021eb /sc/inc/detfunc.hxx | |
| parent | 2ea69ec976fa7bb681746c65807888853ce1b8ea (diff) | |
Modifying comments to meet Doxygen standards
Change-Id: I98ee2cc34bae677e18f7a70a212677704c9c57c5
Reviewed-on: https://gerrit.libreoffice.org/4717
Reviewed-by: Fridrich Strba <fridrich@documentfoundation.org>
Tested-by: Fridrich Strba <fridrich@documentfoundation.org>
Diffstat (limited to 'sc/inc/detfunc.hxx')
| -rw-r--r-- | sc/inc/detfunc.hxx | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/sc/inc/detfunc.hxx b/sc/inc/detfunc.hxx index 0a63da3f3ef4..7b6f75c8fdf1 100644 --- a/sc/inc/detfunc.hxx +++ b/sc/inc/detfunc.hxx @@ -60,20 +60,20 @@ class SC_DLLPUBLIC ScDetectiveFunc enum DrawPosMode { - DRAWPOS_TOPLEFT, /// Top-left edge of the cell. - DRAWPOS_BOTTOMRIGHT, /// Bottom-right edge of the cell. - DRAWPOS_DETARROW, /// Position inside cell for detective arrows. - DRAWPOS_CAPTIONLEFT, /// Top-left edge of the cell for captions. - DRAWPOS_CAPTIONRIGHT /// Top-right edge of the cell for captions (incl. merged cells). + DRAWPOS_TOPLEFT, ///< Top-left edge of the cell. + DRAWPOS_BOTTOMRIGHT, ///< Bottom-right edge of the cell. + DRAWPOS_DETARROW, ///< Position inside cell for detective arrows. + DRAWPOS_CAPTIONLEFT, ///< Top-left edge of the cell for captions. + DRAWPOS_CAPTIONRIGHT ///< Top-right edge of the cell for captions (incl. merged cells). }; - /** Returns a drawing layer position for the passed cell address. */ + /** @return a drawing layer position for the passed cell address. */ Point GetDrawPos( SCCOL nCol, SCROW nRow, DrawPosMode eMode ) const; - /** Returns the drawing layer rectangle for the passed cell range. */ + /** @return the drawing layer rectangle for the passed cell range. */ Rectangle GetDrawRect( SCCOL nCol1, SCROW nRow1, SCCOL nCol2, SCROW nRow2 ) const; - /** Returns the drawing layer rectangle for the passed cell address. */ + /** @return the drawing layer rectangle for the passed cell address. */ Rectangle GetDrawRect( SCCOL nCol, SCROW nRow ) const; sal_Bool HasArrow( const ScAddress& rStart, @@ -86,7 +86,7 @@ class SC_DLLPUBLIC ScDetectiveFunc void FillAttributes( ScDetectiveData& rData ); - // called from DrawEntry/DrawAlienEntry and InsertObject + /// called from DrawEntry/DrawAlienEntry and InsertObject sal_Bool InsertArrow( SCCOL nCol, SCROW nRow, SCCOL nRefStartCol, SCROW nRefStartRow, SCCOL nRefEndCol, SCROW nRefEndRow, @@ -96,7 +96,7 @@ class SC_DLLPUBLIC ScDetectiveFunc SCCOL nEndCol, SCROW nEndRow, sal_Bool bRed, ScDetectiveData& rData ); - // DrawEntry / DrawAlienEntry check for existing arrows and errors + /// DrawEntry / DrawAlienEntry check for existing arrows and errors sal_Bool DrawEntry( SCCOL nCol, SCROW nRow, const ScRange& rRef, ScDetectiveData& rData ); sal_Bool DrawAlienEntry( const ScRange& rRef, @@ -138,8 +138,8 @@ public: void GetAllPreds(SCCOL nCol1, SCROW nRow1, SCCOL nCol2, SCROW nRow2, ::std::vector<ScTokenRef>& rRefTokens); void GetAllSuccs(SCCOL nCol1, SCROW nRow1, SCCOL nCol2, SCROW nRow2, ::std::vector<ScTokenRef>& rRefTokens); - static void UpdateAllComments( ScDocument& rDoc ); // on all tables - void UpdateAllArrowColors(); // on all tables + static void UpdateAllComments( ScDocument& rDoc ); ///< on all tables + void UpdateAllArrowColors(); ///< on all tables static sal_Bool IsNonAlienArrow( SdrObject* pObject ); |