From: Francesco Montorsi <f18m_cpp217828@yahoo.it>
Date: Sun, 30 May 2010 23:28:51 +0000 (+0000)
Subject: Add a simple example to make it easier to get started (by copy&paste).
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/7cfac8c83a1db4c17ebf2091c2de795ca01b542a

Add a simple example to make it easier to get started (by copy&paste).

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@64445 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---

diff --git a/interface/wx/aboutdlg.h b/interface/wx/aboutdlg.h
index 6db5903b8a..0a3a8badb1 100644
--- a/interface/wx/aboutdlg.h
+++ b/interface/wx/aboutdlg.h
@@ -29,6 +29,22 @@
     don't support URLs, licence text nor custom icons in the about dialog and if
     either of those is used, wxAboutBox() will automatically use the generic version
     so you should avoid specifying these fields to achieve more native look and feel.
+    
+    Example of usage:
+    @code
+    void MyFrame::OnAbout(wxCommandEvent& WXUNUSED(event))
+    {
+        wxAboutDialogInfo aboutInfo;
+        aboutInfo.SetName("MyApp");
+        aboutInfo.SetVersion(MY_APP_VERSION_STRING);
+        aboutInfo.SetDescription(_("My wxWidgets-based application!"));
+        aboutInfo.SetCopyright("(C) 1992-2010");
+        aboutInfo.SetWebSite("http://myapp.org");
+        aboutInfo.AddDeveloper("My Self");
+
+        wxAboutBox(aboutInfo);
+    }
+    @endcode
 
     @library{wxadv}
     @category{cmndlg,data}