summaryrefslogtreecommitdiff
path: root/dbaccess
diff options
context:
space:
mode:
authorPhilipp Riemer <ruderphilipp@gmail.com>2012-08-12 18:22:40 +0200
committerPhilipp Riemer <ruderphilipp@gmail.com>2012-08-12 18:22:40 +0200
commit5c293bfa9023fcc4fbb104c49e9ef28d23b38594 (patch)
treeca0c64e8bf5d2bac099fbc519d71a6ae3fbc8e8e /dbaccess
parent0e2c5f8c8bf0e0b8aad4fb9ba8cbe175dc0ce58e (diff)
convert comments into doxygen style + reformat some existing ones
Change-Id: Ia9580f8d6ef19025654b5486816e5a75f76f1174
Diffstat (limited to 'dbaccess')
-rw-r--r--dbaccess/source/ui/inc/DExport.hxx47
-rw-r--r--dbaccess/source/ui/inc/HtmlReader.hxx6
-rw-r--r--dbaccess/source/ui/inc/JoinTableView.hxx104
-rw-r--r--dbaccess/source/ui/inc/QueryTableView.hxx44
-rw-r--r--dbaccess/source/ui/inc/RelationTableView.hxx13
-rw-r--r--dbaccess/source/ui/inc/RtfReader.hxx4
-rw-r--r--dbaccess/source/ui/inc/TableConnection.hxx19
-rw-r--r--dbaccess/source/ui/inc/TableConnectionData.hxx22
-rw-r--r--dbaccess/source/ui/inc/TableDesignControl.hxx5
-rw-r--r--dbaccess/source/ui/inc/TableFieldDescription.hxx8
10 files changed, 139 insertions, 133 deletions
diff --git a/dbaccess/source/ui/inc/DExport.hxx b/dbaccess/source/ui/inc/DExport.hxx
index 974d7c32ebb1..5b6c72fd14e3 100644
--- a/dbaccess/source/ui/inc/DExport.hxx
+++ b/dbaccess/source/ui/inc/DExport.hxx
@@ -60,46 +60,46 @@ namespace dbaui
typedef ::std::vector< ::std::pair<sal_Int32,sal_Int32> > TPositions;
protected:
- TPositions m_vColumns; // columns to be used
- ::std::vector<sal_Int32> m_vColumnTypes; // ColumnTypes for faster access
+ TPositions m_vColumns; ///< columns to be used
+ ::std::vector<sal_Int32> m_vColumnTypes; ///< ColumnTypes for faster access
::std::vector<sal_Int32> m_vColumnSize;
::std::vector<sal_Int16> m_vNumberFormat;
::com::sun::star::lang::Locale m_aLocale;
- TColumns m_aDestColumns; // container for new created columns
+ TColumns m_aDestColumns; ///< container for new created columns
TColumnVector m_vDestVector;
- ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet > m_xTable; // dest table
- ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameAccess> m_xTables; // container
- SharedConnection m_xConnection; // dest conn
+ ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet > m_xTable; ///< dest table
+ ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameAccess> m_xTables; ///< container
+ SharedConnection m_xConnection; ///< dest conn
::boost::shared_ptr<IUpdateHelper> m_pUpdateHelper;
- ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XResultSet > m_xResultSet; //
- ::com::sun::star::uno::Reference< ::com::sun::star::util::XNumberFormatter > m_xFormatter; // a number formatter working with the connection's NumberFormatsSupplier
+ ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XResultSet > m_xResultSet;
+ ::com::sun::star::uno::Reference< ::com::sun::star::util::XNumberFormatter > m_xFormatter; ///< a number formatter working with the connection's NumberFormatsSupplier
::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory> m_xFactory;
::com::sun::star::util::Date m_aNullDate;
SvNumberFormatter* m_pFormatter;
SvStream& m_rInputStream;
- //for save the selected tablename
+ /// for saving the selected tablename
::rtl::OUString m_sDefaultTableName;
- String m_sTextToken; /// cell content
- String m_sNumToken; /// SDNUM value
- String m_sValToken; /// SDVAL value
- TOTypeInfoSP m_pTypeInfo; // contains the default type
+ String m_sTextToken; ///< cell content
+ String m_sNumToken; ///< SDNUM value
+ String m_sValToken; ///< SDVAL value
+ TOTypeInfoSP m_pTypeInfo; ///< contains the default type
const TColumnVector* m_pColumnList;
const OTypeInfoMap* m_pInfoMap;
- sal_Int32 m_nColumnPos; // current column position
- sal_Int32 m_nRows; // number of rows to be searched
- sal_Int32 m_nRowCount; // current count of rows
- rtl_TextEncoding m_nDefToken; // language
- sal_Bool m_bError; // error and termination code
- sal_Bool m_bInTbl; // true, if parser is in RTF table
- sal_Bool m_bHead; // true, if the header hasn't been read yet
- sal_Bool m_bDontAskAgain;// if there is an error when pasting, don't show it again
- sal_Bool m_bIsAutoIncrement; // if PKey is set by user
- sal_Bool m_bFoundTable; // set to true when a table was found
+ sal_Int32 m_nColumnPos; ///< current column position
+ sal_Int32 m_nRows; ///< number of rows to be searched
+ sal_Int32 m_nRowCount; ///< current count of rows
+ rtl_TextEncoding m_nDefToken; ///< language
+ sal_Bool m_bError; ///< error and termination code
+ sal_Bool m_bInTbl; ///< true, if parser is in RTF table
+ sal_Bool m_bHead; ///< true, if the header hasn't been read yet
+ sal_Bool m_bDontAskAgain;///< if there is an error when pasting, don't show it again
+ sal_Bool m_bIsAutoIncrement; ///< if PKey is set by user
+ sal_Bool m_bFoundTable; ///< set to true when a table was found
sal_Bool m_bCheckOnly;
bool m_bAppendFirstLine;
@@ -118,6 +118,7 @@ namespace dbaui
void ensureFormatter();
/** executeWizard calls a wizard to create/append data
+
@param _sTableName the tablename
@param _aTextColor the text color of the new created table
@param _rFont the font of the new table
diff --git a/dbaccess/source/ui/inc/HtmlReader.hxx b/dbaccess/source/ui/inc/HtmlReader.hxx
index 1c76b11f9d27..3e4c5e160da8 100644
--- a/dbaccess/source/ui/inc/HtmlReader.hxx
+++ b/dbaccess/source/ui/inc/HtmlReader.hxx
@@ -36,8 +36,8 @@ namespace dbaui
String m_sCurrent;
sal_Int32 m_nTableCount;
sal_Int16 m_nWidth;
- sal_Int16 m_nColumnWidth; // maximum column width
- sal_Bool m_bMetaOptions; // true when we scanned the meta information
+ sal_Int16 m_nColumnWidth; ///< maximum column width
+ sal_Bool m_bMetaOptions; ///< true when we scanned the meta information
sal_Bool m_bSDNum;
protected:
@@ -71,7 +71,7 @@ namespace dbaui
virtual SvParserState CallParser();// base class
virtual void release();
- // recovers only valid data if 1. CTOR has been used
+ ///< @attention recovers only valid data if 1. CTOR has been used
};
SV_DECL_IMPL_REF( OHTMLReader );
diff --git a/dbaccess/source/ui/inc/JoinTableView.hxx b/dbaccess/source/ui/inc/JoinTableView.hxx
index 1fd68dd423ca..6506efd57fb0 100644
--- a/dbaccess/source/ui/inc/JoinTableView.hxx
+++ b/dbaccess/source/ui/inc/JoinTableView.hxx
@@ -136,23 +136,24 @@ namespace dbaui
virtual void AddConnection(const OJoinExchangeData& jxdSource, const OJoinExchangeData& jxdDest) = 0;
- /** RemoveConnection allows to remove connections from join table view, it implies that the same as addConnection
+ /** RemoveConnection allows to remove connections from join table view
- @param _pConnection
- the connection which should be removed
- @param _bDelete
- when truie then the connection will be deleted
+ it implies that the same as addConnection
+
+ @param _pConnection the connection which should be removed
+ @param _bDelete when true then the connection will be deleted
@return an iterator to next valid connection, so it can be used in any loop
*/
virtual bool RemoveConnection(OTableConnection* _pConnection,sal_Bool _bDelete);
- /** allows to add new connections to join table view, it implies an invalidation of the features
- ID_BROWSER_ADDTABLE and SID_RELATION_ADD_RELATION also the modified flag will be set to true
- @param _pConnection
- the connection which should be added
- @param _bAddData
- <TRUE/> when the data should also be appended
+ /** allows to add new connections to join table view
+
+ it implies an invalidation of the features ID_BROWSER_ADDTABLE and
+ SID_RELATION_ADD_RELATION also the modified flag will be set to true
+
+ @param _pConnection the connection which should be added
+ @param _bAddData when true then the data should also be appended
*/
void addConnection(OTableConnection* _pConnection,sal_Bool _bAddData = sal_True);
@@ -177,40 +178,44 @@ namespace dbaui
sal_Bool ExistsAConn(const OTableWindow* pFromWin) const;
+ /** search for all connections of a table
- /** getTableConnections searchs for all connections of a table
@param _pFromWin the table for which connections should be found
-
@return an iterator which can be used to travel all connections of the table
*/
::std::vector<OTableConnection*>::const_iterator getTableConnections(const OTableWindow* _pFromWin) const;
- /** getConnectionCount returns how many connection belongs to single table
- @param _pFromWin the table for which connections should be found
+ /** how many connection belongs to single table
+ @param _pFromWin the table for which connections should be found
@return the count of connections wich belongs to this table
*/
sal_Int32 getConnectionCount(const OTableWindow* _pFromWin) const;
OTableConnection* GetTabConn(const OTableWindow* pLhs,const OTableWindow* pRhs,bool _bSupressCrossOrNaturalJoin = false,const OTableConnection* _rpFirstAfter = NULL) const;
- // clears the window map and connection vector without destroying it
- // that means teh data of the windows and connection will be untouched
+ /** clear the window map and connection vector without destroying it
+
+ that means that the data of the windows and connection will be
+ untouched
+ */
void clearLayoutInformation();
- // set the focus to that tab win which most recently had it (or to the first available one)
+ /** set the focus to that tab win which most recently had it
+ (or to the first available one) **/
void GrabTabWinFocus();
- // ReSync is meant to get all WinData and ConnData from the document
- // and create the corresponding Wins and Conns
+ /** take all WinData and ConnData from the document and create the
+ corresponding Wins and Conns */
virtual void ReSync() { }
- // ClearAll implements hart deletion, all Conns and Wins are deleted
- // from their respective lists and the corresponding Datas removed
- // from the document
+ /** Hart deletion
+
+ That means that all Conns and Wins are deleted from their respective
+ lists and the corresponding Datas removed from the document */
virtual void ClearAll();
- // used by AddTabDlg to see if more tables can be added
+ /** @note used by AddTabDlg to see if more tables can be added */
virtual sal_Bool IsAddAllowed();
virtual long PreNotify(NotifyEvent& rNEvt);
@@ -219,14 +224,11 @@ namespace dbaui
virtual sal_Int8 AcceptDrop( const AcceptDropEvent& rEvt );
virtual sal_Int8 ExecuteDrop( const ExecuteDropEvent& rEvt );
- /**
- can be used in derevied classes to make some special ui handling
- after d&d
- */
+ /** @note can be used for special ui handling after d&d */
virtual void lookForUiActivities();
- // called after moving/resizing TabWins
- // (the standard implementation just passes the new data to the Wins)
+ /// called after moving/resizing TabWins
+ /// (the standard implementation just passes the new data to the Wins)
virtual void TabWinMoved(OTableWindow* ptWhich, const Point& ptOldPosition);
// the position is 'virtual': the container has a virtual area
// of which only a part - changeable by scroll bar - is visible
@@ -237,13 +239,10 @@ namespace dbaui
void modified();
/** check if the given window is visible.
- @param _rPoint
- The Point to check
- @param _rSize
- The Size to be check as well
- @return
- <TRUE/> if the area is visible otherwise <FALSE/>
+ @param _rPoint The Point to check
+ @param _rSize The Size to be check as well
+ @return true if the area is visible, false otherwise
*/
sal_Bool isMovementAllowed(const Point& _rPoint,const Size& _rSize);
@@ -270,8 +269,8 @@ namespace dbaui
virtual void Resize();
virtual void dragFinished( );
- // here the physical position (that can be changed while resizing)
- // is used, as no scrolling can take place while resizing
+ /// @note here the physical position (that can be changed while
+ /// resizing) is used, as no scrolling can take place while resizing
virtual void Command(const CommandEvent& rEvt);
virtual OTableWindowData* CreateImpl(const ::rtl::OUString& _rComposedName
@@ -279,20 +278,19 @@ namespace dbaui
,const ::rtl::OUString& _rWinName);
/** factory method to create table windows
- @param _pData
- The data corresponding to the window.
- @return
- The new TableWindow
+
+ @param _pData The data corresponding to the window.
+ @return The new TableWindow
*/
virtual OTableWindow* createWindow(const TTableWindowData::value_type& _pData) = 0;
- /** determines whether the classes Init method should accept a query name, or only table names
- */
+ /** determines whether the classes Init method should accept a query
+ name, or only table names */
virtual bool allowQueries() const;
- /** called when init fails at the tablewindowdata because the m_xTable object could not provide columns, but no
- exception was thrown. Expected to throw.
- */
+ /** called when init fails at the tablewindowdata because the m_xTable
+ object could not provide columns, but no exception was thrown.
+ Expected to throw. */
virtual void onNoColumns_throw();
virtual bool supressCrossNaturalJoin(const TTableConnectionData::value_type& _pData) const;
@@ -301,15 +299,15 @@ namespace dbaui
void InitColors();
sal_Bool ScrollWhileDragging();
- /** executePopup opens the context menu to delate a connection
- @param _aPos the position where the popup menu should appear
- @param _pSelConnection the connection which should be deleted
+ /** opens the context menu to delate a connection
+ @param _aPos the position where the popup menu should appear
+ @param _pSelConnection the connection which should be deleted
*/
void executePopup(const Point& _aPos,OTableConnection* _pSelConnection);
- /** invalidateAndModify invalidates this window without children and
- set the controller modified
- @param _pAction a possible undo action to add at the controller
+ /** invalidates this window without children and set the controller
+ modified
+ @param _pAction a possible undo action to add at the controller
*/
void invalidateAndModify(SfxUndoAction *_pAction=NULL);
diff --git a/dbaccess/source/ui/inc/QueryTableView.hxx b/dbaccess/source/ui/inc/QueryTableView.hxx
index 3763b0527a73..003309b671e4 100644
--- a/dbaccess/source/ui/inc/QueryTableView.hxx
+++ b/dbaccess/source/ui/inc/QueryTableView.hxx
@@ -50,9 +50,9 @@ namespace dbaui
virtual OTableWindow* createWindow(const TTableWindowData::value_type& _pData);
- /** called when init fails at the tablewindowdata because the m_xTable object could not provide columns, but no
- exception was thrown. Expected to throw.
- */
+ /** called when init fails at the tablewindowdata because the m_xTable
+ object could not provide columns, but no exception was thrown.
+ Expected to throw. */
virtual void onNoColumns_throw();
virtual bool supressCrossNaturalJoin(const TTableConnectionData::value_type& _pData) const;
@@ -60,60 +60,61 @@ namespace dbaui
OQueryTableView(Window* pParent,OQueryDesignView* pView);
virtual ~OQueryTableView();
- // base class overwritten: create and delete windows
- // (not really delete, as it becomes an UNDO action)
+ /// base class overwritten: create and delete windows
+ /// (not really delete, as it becomes an UndoAction)
virtual void AddTabWin( const ::rtl::OUString& _rTableName, const ::rtl::OUString& _rAliasName, sal_Bool bNewTable = sal_False );
virtual void RemoveTabWin(OTableWindow* pTabWin);
- // AddTabWin, setting an alias
+ /// AddTabWin, setting an alias
void AddTabWin(const ::rtl::OUString& strDatabase, const ::rtl::OUString& strTableName, const ::rtl::OUString& strAlias, sal_Bool bNewTable = sal_False);
/// search TabWin
OQueryTableWindow* FindTable(const String& rAliasName);
sal_Bool FindTableFromField(const String& rFieldName, OTableFieldDescRef& rInfo, sal_uInt16& rCnt);
- // base class overwritten: create and delete Connections
+ /// base class overwritten: create and delete Connections
virtual void AddConnection(const OJoinExchangeData& jxdSource, const OJoinExchangeData& jxdDest);
virtual bool RemoveConnection( OTableConnection* _pConn ,sal_Bool _bDelete);
// transfer of connections from and to UndoAction
+
+ /// Inserting a Connection the structure
void GetConnection(OQueryTableConnection* pConn);
- // Inserting a connection into the structure
- void DropConnection(OQueryTableConnection* pConn);
- // Removing a connection from the structure
+ /** Removing a Connection from the structure
- // results in complete reset of request form, as
- // all windows are hidden, as are all Connections to these windows
- // and all request columns based on those tables
+ This results effectively in complete reset of request form, as all
+ windows are hidden, as are all Connections to these windows and all
+ request columns based on those tables */
+ void DropConnection(OQueryTableConnection* pConn);
// show and hide TabWin (NOT create or delete)
sal_Bool ShowTabWin(OQueryTableWindow* pTabWin, OQueryTabWinUndoAct* pUndoAction,sal_Bool _bAppend);
void HideTabWin(OQueryTableWindow* pTabWin, OQueryTabWinUndoAct* pUndoAction);
- // ensure visibility of TabWins (+ and invalidate connections)
+ /// ensure visibility of TabWins (+ and invalidate connections)
virtual void EnsureVisible(const OTableWindow* _pWin);
- // how many tables with a certain alias do I already have?
+ /// how many tables with a certain alias do I already have?
sal_Int32 CountTableAlias(const String& rName, sal_Int32& rMax);
/// insert field (simply passed to parents)
void InsertField(const OTableFieldDescRef& rInfo);
- // rebuild everything (TabWins, Connections)
- // (PRECONDITION: ClearAll was called previously)
+ /// rebuild everything (TabWins, Connections)
+ /// (PRECONDITION: ClearAll was called previously)
virtual void ReSync();
- // delete everything hard (TabWins, Connections), without any notifications
+ /// delete everything hard (TabWins, Connections), without any notifications
virtual void ClearAll();
// used by AddTabDlg to see if tables can still be added
//virtual sal_Bool IsAddAllowed();
- // announce new Connection and insert it, if not existant yet
+ /// announce new Connection and insert it, if not existant yet
void NotifyTabConnection(const OQueryTableConnection& rNewConn, sal_Bool _bCreateUndoAction = sal_True);
+ /// @note the Handler receives a pointer to a TabWinsChangeNotification struct
Link SetTabWinsChangeHandler(const Link& lnk) { Link lnkRet = m_lnkTabWinsChangeHandler; m_lnkTabWinsChangeHandler = lnk; return lnkRet; }
- // the Handler receives a pointer to a TabWinsChangeNotification struct
sal_Bool ExistsAVisitedConn(const OQueryTableWindow* pFrom) const;
@@ -121,8 +122,7 @@ namespace dbaui
,const ::rtl::OUString& _sTableName
,const ::rtl::OUString& _rWinName);
- /** createNewConnection opens the join dialog and allows to create a new join connection
- */
+ /** opens the join dialog and allows to create a new join connection */
void createNewConnection();
private:
diff --git a/dbaccess/source/ui/inc/RelationTableView.hxx b/dbaccess/source/ui/inc/RelationTableView.hxx
index 9db4180c56af..acffe8325370 100644
--- a/dbaccess/source/ui/inc/RelationTableView.hxx
+++ b/dbaccess/source/ui/inc/RelationTableView.hxx
@@ -31,8 +31,8 @@ namespace dbaui
, public OJoinTableView
, public ::comphelper::OContainerListener
{
- OTableConnection* m_pExistingConnection; // is set when a connection was draged on an existing connection
- TTableConnectionData::value_type m_pCurrentlyTabConnData; // set when we creating a connection with more than one keycolumn
+ OTableConnection* m_pExistingConnection; ///< is set when a connection was draged on an existing connection
+ TTableConnectionData::value_type m_pCurrentlyTabConnData; ///< set when we creating a connection with more than one keycolumn
::rtl::Reference< comphelper::OContainerListenerAdapter>
m_pContainerListener;
bool m_bInRemove;
@@ -42,8 +42,8 @@ namespace dbaui
virtual OTableWindow* createWindow(const TTableWindowData::value_type& _pData);
- /** determines whether the classes Init method should accept a query name, or only table names
- */
+ /** determines whether the classes Init method should accept a query
+ name, or only table names */
virtual bool allowQueries() const;
// OContainerListener
@@ -61,9 +61,10 @@ namespace dbaui
virtual void ReSync();
+ /// Creates a dialogue for a completely new relation.
void AddNewRelation();
- // Creates a dialogue for a completely new relation.
- // used by AddTabDlg to check if tables can be added
+
+ /// used by AddTabDlg to check if tables can be added
virtual sal_Bool IsAddAllowed();
virtual void lookForUiActivities();
diff --git a/dbaccess/source/ui/inc/RtfReader.hxx b/dbaccess/source/ui/inc/RtfReader.hxx
index 0e41fdb8effd..040d692f239b 100644
--- a/dbaccess/source/ui/inc/RtfReader.hxx
+++ b/dbaccess/source/ui/inc/RtfReader.hxx
@@ -58,9 +58,9 @@ namespace dbaui
sal_Bool _bAutoIncrementEnabled);
virtual SvParserState CallParser();// base class
+ /// @note Only recovers correct data if 2. CTOR has been used.
+ /// Otherwise, the SbaColumnList will be returned without changes
virtual void release();
- // Only recovers correct data if 2. CTOR has been used.
- // Otherwise, the SbaColumnList will be returned without changes.
};
SV_DECL_IMPL_REF( ORTFReader );
diff --git a/dbaccess/source/ui/inc/TableConnection.hxx b/dbaccess/source/ui/inc/TableConnection.hxx
index b9c8edc4c931..ad87d643d4d5 100644
--- a/dbaccess/source/ui/inc/TableConnection.hxx
+++ b/dbaccess/source/ui/inc/TableConnection.hxx
@@ -47,8 +47,7 @@ namespace dbaui
sal_Bool m_bSelected;
void Init();
- /** clearLineData loops through the vector and deletes all lines
- */
+ /** loops through the vector and deletes all lines */
void clearLineData();
protected:
@@ -57,11 +56,15 @@ namespace dbaui
public:
OTableConnection( OJoinTableView* pContainer, const TTableConnectionData::value_type& pTabConnData );
OTableConnection( const OTableConnection& rConn );
- // IMPORTANT: Normally a pointer to OTableConnectionData is given but
- // here, however, one has to create an instance (with
- // OTableConnectionDate::NewInstance) which is never deleted (same like
- // in other cases). Thus, the caller is responsible to check and save
- // the data for deleting it eventually.
+ /** destructor
+
+ @attention Normally a pointer to OTableConnectionData is given but
+ here, however, one has to create an instance (with
+ OTableConnectionDate::NewInstance) which is never deleted
+ (same like in other cases). Thus, the caller is
+ responsible to check and save the data for deleting it
+ eventually.
+ */
virtual ~OTableConnection();
OTableConnection& operator=( const OTableConnection& rConn );
@@ -79,8 +82,8 @@ namespace dbaui
bool RecalcLines();
/** isTableConnection
- @param _pTable the table where we should check if we belongs to it
+ @param _pTable the table where we should check if we belongs to it
@return true when the source or the destination window are equal
*/
bool isTableConnection(const OTableWindow* _pTable)
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; }
diff --git a/dbaccess/source/ui/inc/TableDesignControl.hxx b/dbaccess/source/ui/inc/TableDesignControl.hxx
index b63ce3f63dea..b7f6493f6efa 100644
--- a/dbaccess/source/ui/inc/TableDesignControl.hxx
+++ b/dbaccess/source/ui/inc/TableDesignControl.hxx
@@ -35,8 +35,9 @@ namespace dbaui
friend class OTableDesignUndoAct;
protected:
- long m_nDataPos; // currently needed row
- long m_nCurrentPos; // current position of selected column
+ long m_nDataPos; ///< currently needed row
+ long m_nCurrentPos; ///< current position of selected column
+
private:
sal_uInt16 m_nCurUndoActId;
protected:
diff --git a/dbaccess/source/ui/inc/TableFieldDescription.hxx b/dbaccess/source/ui/inc/TableFieldDescription.hxx
index 2e2d859ae370..29d31e7f3e94 100644
--- a/dbaccess/source/ui/inc/TableFieldDescription.hxx
+++ b/dbaccess/source/ui/inc/TableFieldDescription.hxx
@@ -43,10 +43,10 @@ namespace dbaui
m_aCriteria;
::rtl::OUString m_aTableName;
- ::rtl::OUString m_aAliasName; // table range
- ::rtl::OUString m_aFieldName; // column
- ::rtl::OUString m_aFieldAlias; // column alias
- ::rtl::OUString m_aFunctionName; // contains the function name (only if m_eFunctionType != FKT_NONE)
+ ::rtl::OUString m_aAliasName; ///< table range
+ ::rtl::OUString m_aFieldName; ///< column
+ ::rtl::OUString m_aFieldAlias; ///< column alias
+ ::rtl::OUString m_aFunctionName;///< contains the function name (only if m_eFunctionType != FKT_NONE)
Window* m_pTabWindow;