diff options
author | Philipp Riemer <ruderphilipp@gmail.com> | 2012-08-12 18:22:40 +0200 |
---|---|---|
committer | Philipp Riemer <ruderphilipp@gmail.com> | 2012-08-12 18:22:40 +0200 |
commit | 5c293bfa9023fcc4fbb104c49e9ef28d23b38594 (patch) | |
tree | ca0c64e8bf5d2bac099fbc519d71a6ae3fbc8e8e /dbaccess/source/ui/inc/TableConnectionData.hxx | |
parent | 0e2c5f8c8bf0e0b8aad4fb9ba8cbe175dc0ce58e (diff) |
convert comments into doxygen style + reformat some existing ones
Change-Id: Ia9580f8d6ef19025654b5486816e5a75f76f1174
Diffstat (limited to 'dbaccess/source/ui/inc/TableConnectionData.hxx')
-rw-r--r-- | dbaccess/source/ui/inc/TableConnectionData.hxx | 22 |
1 files changed, 12 insertions, 10 deletions
diff --git a/dbaccess/source/ui/inc/TableConnectionData.hxx b/dbaccess/source/ui/inc/TableConnectionData.hxx index a605c1cd67df..620f4cf353f7 100644 --- a/dbaccess/source/ui/inc/TableConnectionData.hxx +++ b/dbaccess/source/ui/inc/TableConnectionData.hxx @@ -37,9 +37,7 @@ namespace dbaui //================================================================== - /* - the class OTableConnectionData contains all connection data which exists between two windows - **/ + /** Contains all connection data which exists between two windows */ class OTableConnectionData { @@ -62,23 +60,27 @@ namespace dbaui OTableConnectionData( const OTableConnectionData& rConnData ); virtual ~OTableConnectionData(); - // initialise from a source (more comfortable than a virtual assignment operator) + /// initialise from a source (more comfortable than a virtual assignment operator) virtual void CopyFrom(const OTableConnectionData& rSource); - // deliver a new instance of my own type (does NOT have to be initialised) + /** deliver a new instance of my own type + + derived classes have to deliver an instance of their own type + + @note does NOT have to be initialised + */ virtual OTableConnectionData* NewInstance() const; - // classes derived from OTableConnectionData correspondingly - // have to deliver an instance of their own type sal_Bool SetConnLine( sal_uInt16 nIndex, const String& rSourceFieldName, const String& rDestFieldName ); sal_Bool AppendConnLine( const ::rtl::OUString& rSourceFieldName, const ::rtl::OUString& rDestFieldName ); void ResetConnLines( sal_Bool bUseDefaults = sal_True ); - /** normalizeLines moves the empty lines to the back + /** moves the empty lines to the back + + Deletes list of ConnLines; if bUseDefaults == true + MAX_CONN_COUNT new dummy lines will be inserted. */ void normalizeLines(); - // deletes list of ConnLines, if bUseDefaults == sal_True - // MAX_CONN_COUNT new dummy lines will be inserted OConnectionLineDataVec* GetConnLineDataList(){ return &m_vConnLineData; } |