From a005a22e6ea41d55889070cea724b33c718cde8d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Cl=C3=A9ment=20Stenac?= <zorglub@videolan.org>
Date: Sun, 4 Dec 2005 21:24:08 +0000
Subject: [PATCH] Clean up - convert todos to doxygen style
---
modules/gui/skins2/commands/cmd_playtree.cpp | 2 +-
modules/gui/skins2/controls/ctrl_tree.cpp | 9 ++-------
modules/gui/skins2/utils/var_tree.cpp | 2 +-
modules/gui/skins2/utils/var_tree.hpp | 2 +-
modules/gui/skins2/vars/playtree.cpp | 6 ++----
5 files changed, 7 insertions(+), 14 deletions(-)
diff --git a/modules/gui/skins2/commands/cmd_playtree.cpp b/modules/gui/skins2/commands/cmd_playtree.cpp
index b565bffa8727..3a16766424c2 100644
--- a/modules/gui/skins2/commands/cmd_playtree.cpp
+++ b/modules/gui/skins2/commands/cmd_playtree.cpp
@@ -32,7 +32,7 @@ void CmdPlaytreeDel::execute()
void CmdPlaytreeSort::execute()
{
- // TODO: Choose sort method
+ /// \todo Choose sort method/order - Need more commands
playlist_t *p_playlist = getIntf()->p_sys->p_playlist;
vlc_mutex_lock( &p_playlist->object_lock );
playlist_view_t* p_view = playlist_ViewFind( p_playlist, p_playlist->status.i_view );
diff --git a/modules/gui/skins2/controls/ctrl_tree.cpp b/modules/gui/skins2/controls/ctrl_tree.cpp
index 7023ef8bc572..ee3ba0848731 100644
--- a/modules/gui/skins2/controls/ctrl_tree.cpp
+++ b/modules/gui/skins2/controls/ctrl_tree.cpp
@@ -145,9 +145,7 @@ void CtrlTree::onUpdate( Subject<VarTree, tree_update*> &rTree,
}
else if ( arg->i_type == 2 ) // Item-append
{
- /* TODO: Check if the item should be visible. If it is, makeImage
- * Else, do nothing
- */
+ /// \todo Check if the really is really visible in the view (we only check if it in the document)
if( arg->b_visible == true )
{
makeImage();
@@ -184,7 +182,6 @@ void CtrlTree::onUpdate( Subject<VarPercent, void*> &rPercent, void* arg)
void CtrlTree::onResize()
{
- // FIXME : shouldn't be the same as the onUpdate function ... but i'm lazy
// Determine what is the first item to display
VarTree::Iterator it = m_rTree.begin();
@@ -665,9 +662,7 @@ void CtrlTree::makeImage()
}
it = m_rTree.getNextVisibleItem( it );
}
- /* TODO: Reposition percentage var to accomodate if it's not suitable anymore
- * (if we expanded a node)
- */
+ /// \todo Reposition percentage var to accomodate if it's not suitable anymore (if we expanded a node)
}
VarTree::Iterator CtrlTree::findItemAtPos( int pos )
diff --git a/modules/gui/skins2/utils/var_tree.cpp b/modules/gui/skins2/utils/var_tree.cpp
index eff1bb4c1ae2..30f000a863e5 100644
--- a/modules/gui/skins2/utils/var_tree.cpp
+++ b/modules/gui/skins2/utils/var_tree.cpp
@@ -49,7 +49,7 @@ VarTree::VarTree( intf_thread_t *pIntf, VarTree *pParent, int id,
VarTree::~VarTree()
{
-// TODO : check that children are deleted
+/// \todo check that children are deleted
}
void VarTree::add( int id, const UStringPtr &rcString, bool selected,
diff --git a/modules/gui/skins2/utils/var_tree.hpp b/modules/gui/skins2/utils/var_tree.hpp
index 1cebb8f234f8..b8073888b5ab 100644
--- a/modules/gui/skins2/utils/var_tree.hpp
+++ b/modules/gui/skins2/utils/var_tree.hpp
@@ -65,7 +65,7 @@ class VarTree: public Variable, public Subject<VarTree, tree_update*>
/// Remove all elements from the children's list
virtual void clear();
- /// FIXME should be private
+ /// \todo Use accessors for these fields ?
int m_id;
UStringPtr m_cString;
bool m_selected;
diff --git a/modules/gui/skins2/vars/playtree.cpp b/modules/gui/skins2/vars/playtree.cpp
index 08a19563245e..fc6af1ad867e 100644
--- a/modules/gui/skins2/vars/playtree.cpp
+++ b/modules/gui/skins2/vars/playtree.cpp
@@ -54,7 +54,6 @@ Playtree::Playtree( intf_thread_t *pIntf ): VarTree( pIntf )
Playtree::~Playtree()
{
if( iconvHandle != (vlc_iconv_t) - 1 ) vlc_iconv_close( iconvHandle );
- // TODO : check that everything is destroyed
}
void Playtree::delSelected()
@@ -79,7 +78,7 @@ void Playtree::delSelected()
}
}
}
- // TODO: Do this better
+ /// \todo Do this better (handle item-deleted)
buildTree();
tree_update descr;
descr.i_type = 1;
@@ -188,10 +187,9 @@ void Playtree::buildTree()
playlist_view_t *p_view;
p_view = playlist_ViewFind( m_pPlaylist, VIEW_CATEGORY );
- /* TODO : let the user chose the view type */
+ /// \todo let the user chose the view
clear();
- /* XXX : do we need Playlist::clear() instead of VarTree::clear() ? */
/* Set the root's name */
UString *pName = new UString( getIntf(), p_view->p_root->input.psz_name );
--
GitLab