diff options
| author | Jon A. Cruz <jon@joncruz.org> | 2011-10-27 04:55:51 +0000 |
|---|---|---|
| committer | Jon A. Cruz <jon@joncruz.org> | 2011-10-27 04:55:51 +0000 |
| commit | 2633767789e4264b13ef91a684accf734fb4e94f (patch) | |
| tree | 0f6bc8d758b8e4bcf01d2dd393166907906c156e /src/ui/view | |
| parent | Cleanup pass on documentation that was dumping garbage into doxygen output. (diff) | |
| download | inkscape-2633767789e4264b13ef91a684accf734fb4e94f.tar.gz inkscape-2633767789e4264b13ef91a684accf734fb4e94f.zip | |
Fixing more broken and split doc comments.
(bzr r10697)
Diffstat (limited to 'src/ui/view')
| -rw-r--r-- | src/ui/view/view-widget.cpp | 16 | ||||
| -rw-r--r-- | src/ui/view/view-widget.h | 24 | ||||
| -rw-r--r-- | src/ui/view/view.cpp | 16 | ||||
| -rw-r--r-- | src/ui/view/view.h | 14 |
4 files changed, 35 insertions, 35 deletions
diff --git a/src/ui/view/view-widget.cpp b/src/ui/view/view-widget.cpp index d43877569..7876928f7 100644 --- a/src/ui/view/view-widget.cpp +++ b/src/ui/view/view-widget.cpp @@ -1,6 +1,4 @@ -/** \file - * SPViewWidget implementation. - * +/* * Authors: * Lauris Kaplinski <lauris@kaplinski.com> * Ralf Stephan <ralf@ark.in-berlin.de> @@ -16,7 +14,7 @@ //using namespace Inkscape::UI::View; -/* SPViewWidget */ +// SPViewWidget static void sp_view_widget_class_init(SPViewWidgetClass *vwc); static void sp_view_widget_init(SPViewWidget *widget); @@ -24,9 +22,6 @@ static void sp_view_widget_destroy(GtkObject *object); static GtkEventBoxClass *widget_parent_class; -/** - * Registers the SPViewWidget class with Glib and returns its type number. - */ GType sp_view_widget_get_type(void) { static GType type = 0; @@ -89,10 +84,6 @@ static void sp_view_widget_destroy(GtkObject *object) Inkscape::GC::request_early_collection(); } -/** - * Connects widget to view's 'resized' signal and calls virtual set_view() - * function. - */ void sp_view_widget_set_view(SPViewWidget *vw, Inkscape::UI::View::View *view) { g_return_if_fail(vw != NULL); @@ -109,9 +100,6 @@ void sp_view_widget_set_view(SPViewWidget *vw, Inkscape::UI::View::View *view) } } -/** - * Calls the virtual shutdown() function of the SPViewWidget. - */ bool sp_view_widget_shutdown(SPViewWidget *vw) { g_return_val_if_fail(vw != NULL, TRUE); diff --git a/src/ui/view/view-widget.h b/src/ui/view/view-widget.h index 5143054d2..668f9d19a 100644 --- a/src/ui/view/view-widget.h +++ b/src/ui/view/view-widget.h @@ -33,15 +33,27 @@ class SPNamedView; #define SP_VIEW_WIDGET_VIEW(w) (SP_VIEW_WIDGET (w)->view) #define SP_VIEW_WIDGET_DOCUMENT(w) (SP_VIEW_WIDGET (w)->view ? ((SPViewWidget *) (w))->view->doc : NULL) -GType sp_view_widget_get_type (void); +/** + * Registers the SPViewWidget class with Glib and returns its type number. + */ +GType sp_view_widget_get_type(void); -void sp_view_widget_set_view (SPViewWidget *vw, Inkscape::UI::View::View *view); +/** + * Connects widget to view's 'resized' signal and calls virtual set_view() + * function. + */ +void sp_view_widget_set_view(SPViewWidget *vw, Inkscape::UI::View::View *view); -/// Allows presenting 'save changes' dialog, FALSE - continue, TRUE - cancel -bool sp_view_widget_shutdown (SPViewWidget *vw); +/** + * Allows presenting 'save changes' dialog, FALSE - continue, TRUE - cancel. + * Calls the virtual shutdown() function of the SPViewWidget. + */ +bool sp_view_widget_shutdown(SPViewWidget *vw); -/// Create a new SPViewWidget (which happens to be a SPDesktopWidget). -SPViewWidget *sp_desktop_widget_new (SPNamedView *namedview); +/** + * Create a new SPViewWidget (which happens to be a SPDesktopWidget). + */ +SPViewWidget *sp_desktop_widget_new(SPNamedView *namedview); /** * SPViewWidget is a GUI widget that contain a single View. It is also diff --git a/src/ui/view/view.cpp b/src/ui/view/view.cpp index dc6307ab0..e13976cc4 100644 --- a/src/ui/view/view.cpp +++ b/src/ui/view/view.cpp @@ -1,6 +1,4 @@ -/** \file - * View implementation - * +/* * Authors: * Lauris Kaplinski <lauris@kaplinski.com> * Ralf Stephan <ralf@ark.in-berlin.de> @@ -78,9 +76,6 @@ View::View() _message_changed_connection = _message_stack->connectChanged (sigc::bind (sigc::ptr_fun (&_onStatusMessage), this)); } -/** - * Deletes and nulls all View message stacks and disconnects it from signals. - */ View::~View() { _close(); @@ -127,15 +122,6 @@ void View::requestRedraw() _redraw_requested_signal.emit(); } -/** - * Disconnects the view from the document signals, connects the view - * to a new one, and emits the _document_set_signal on the view. - * - * This is code comon to all subclasses and called from their - * setDocument() methods after they are done. - * - * \param doc The new document to connect the view to. - */ void View::setDocument(SPDocument *doc) { g_return_if_fail(doc != NULL); diff --git a/src/ui/view/view.h b/src/ui/view/view.h index 8b30aead2..6ed9f476c 100644 --- a/src/ui/view/view.h +++ b/src/ui/view/view.h @@ -72,6 +72,10 @@ class View : public GC::Managed<>, public: View(); + + /** + * Deletes and nulls all View message stacks and disconnects it from signals. + */ virtual ~View(); void close() { _close(); } @@ -110,6 +114,16 @@ protected: Inkscape::MessageContext *_tips_message_context; virtual void _close(); + + /** + * Disconnects the view from the document signals, connects the view + * to a new one, and emits the _document_set_signal on the view. + * + * This is code comon to all subclasses and called from their + * setDocument() methods after they are done. + * + * @param doc The new document to connect the view to. + */ virtual void setDocument(SPDocument *doc); sigc::signal<void,double,double> _position_set_signal; |
