From cc08d39f2e372f07f7b5c0445bd2e3a6b0b59a47 Mon Sep 17 00:00:00 2001 From: Amar Takhar Date: Thu, 30 Jul 2009 02:09:21 +0000 Subject: [PATCH] Dcoument AegisubFileDropTarget. Originally committed to SVN as r3321. --- aegisub/src/drop.cpp | 13 +++++++------ aegisub/src/drop.h | 10 +++------- 2 files changed, 10 insertions(+), 13 deletions(-) diff --git a/aegisub/src/drop.cpp b/aegisub/src/drop.cpp index eb6ffc66f..526ef3de4 100644 --- a/aegisub/src/drop.cpp +++ b/aegisub/src/drop.cpp @@ -45,8 +45,8 @@ -/// @brief Constructor -/// @param par +/// @brief Constructor +/// @param par Parent frame /// AegisubFileDropTarget::AegisubFileDropTarget(FrameMain *par) { parent = par; @@ -54,10 +54,11 @@ AegisubFileDropTarget::AegisubFileDropTarget(FrameMain *par) { -/// @brief Drop files -/// @param x -/// @param y -/// @param filenames +/// @brief Handle dropped files. +/// @param x X drop co-ordinate. +/// @param y Y drop co-ordinate +/// @param filenames List of files dropped. +/// @return Whether handling dropped files was sucessful /// bool AegisubFileDropTarget::OnDropFiles(wxCoord x, wxCoord y, const wxArrayString& filenames) { return parent->LoadList(filenames); diff --git a/aegisub/src/drop.h b/aegisub/src/drop.h index 7fd95908c..b501baf8a 100644 --- a/aegisub/src/drop.h +++ b/aegisub/src/drop.h @@ -37,7 +37,7 @@ #ifndef DROP_H -/// DOCME +/// Inclusion guard #define DROP_H @@ -53,15 +53,13 @@ class FrameMain; -/// DOCME /// @class AegisubFileDropTarget -/// @brief DOCME +/// @brief Handle files DnD'd onto Aegisub /// -/// DOCME class AegisubFileDropTarget : public wxFileDropTarget { private: - /// DOCME + /// Parent frame FrameMain *parent; public: @@ -72,5 +70,3 @@ public: }; #endif - -