Fixed up the splash page documentation.

[endlessm/eos-sdk#62]

5 files changed, 50 insertions, 19 deletions

diff --git a/docs/reference/endless/endless-docs.xml b/docs/reference/endless/endless-docs.xml
index 0ae881f..1d63323 100644
--- a/docs/reference/endless/endless-docs.xml
+++ b/docs/reference/endless/endless-docs.xml
@@ -21,6 +21,7 @@
         <xi:include href="xml/window.xml"/>
         <xi:include href="xml/page-manager.xml"/>
         <xi:include href="xml/enums.xml"/>
+        <xi:include href="xml/splash-page-manager.xml"/>
         <!--<xi:include href="xml/hello.xml"/>-->
   </chapter>
 
diff --git a/docs/reference/endless/endless-sections.txt b/docs/reference/endless/endless-sections.txt
index 6b40e61..a81d852 100644
--- a/docs/reference/endless/endless-sections.txt
+++ b/docs/reference/endless/endless-sections.txt
@@ -82,3 +82,26 @@ EosPageManagerPrivate
 <FILE>enums</FILE>
 EosActionButtonSize
 </SECTION>
+
+<SECTION>
+<FILE>splash-page-manager</FILE>
+EosSplashPageManager
+eos_splash_page_manager_new
+eos_splash_page_manager_get_splash_page
+eos_splash_page_manager_set_splash_page
+eos_splash_page_manager_get_main_page
+eos_splash_page_manager_set_main_page
+eos_splash_page_manager_show_main_page
+eos_splash_page_manager_show_splash_page
+<SUBSECTION Standard>
+EOS_IS_SPLASH_PAGE_MANAGER
+EOS_IS_SPLASH_PAGE_MANAGER_CLASS
+EOS_SPLASH_PAGE_MANAGER
+EOS_SPLASH_PAGE_MANAGER_CLASS
+EOS_SPLASH_PAGE_MANAGER_GET_CLASS
+EOS_TYPE_SPLASH_PAGE_MANAGER
+EosSplashPageManagerClass
+eos_splash_page_manager_get_type
+<SUBSECTION Private>
+EosSplashPageManagerPrivate
+</SECTION>
diff --git a/endless/eospagemanager.c b/endless/eospagemanager.c
index 7e21603..2db0975 100644
--- a/endless/eospagemanager.c
+++ b/endless/eospagemanager.c
@@ -25,7 +25,7 @@
  * The default page manager, described in this section of the manual, lets you
  * add any number of pages and switch between them however you like, but there
  * are also other, more specialized ones:
- * for example, the #EosSplashScreenPageManager displays a splash screen and
+ * for example, the #EosSplashPageManager displays a splash screen and
  * later turns control over to a different page or page manager when you signal
  * it to;
  * and the #EosTabbedPageManager creates a tabbed interface in your window, much
diff --git a/endless/eossplashpagemanager.c b/endless/eossplashpagemanager.c
index 27057a9..e73a7a7 100644
--- a/endless/eossplashpagemanager.c
+++ b/endless/eossplashpagemanager.c
@@ -12,16 +12,22 @@
  * @short_description: Add splash screen to application
  * @title: Splash Page Manager
  *
- * Builds on the #EosSplashPageManager to provide an application with two pages. The
- * first page is called the splash screen and provides a simple welcome screen
- * with minimal user interface. Once the user complete any action needed on
- * the splash screen page (e.g. select a file to open), they will be taken to
- * the main screen where the main work of the application will be done.
+ * Builds on the #EosPageManager to provide an application with two pages.
+ * The first page is called the splash page and is the first page to be
+ * presented to the user. This is generally a simple page with a minimal
+ * interface that acts as a gateway to the rest of the application.
+ *
+ * The second page, called the main page, is generally where the main work of
+ * the application will get done. This can be shown instead of the splash page
+ * at any time by calling eos_splash_page_manager_show_main_page(). The main
+ * page can be a second page manager (such as a tabbed notebook view), for
+ * applications with more complex page flow.
  *
  * The splash screen and main page can contain any widget. Call
- * show_main_page() and show_splash_page() to toggle between the two views.
- * The splash screen will be shown by default until a call to show_main_page()
- * is made.
+ * eos_splash_page_manager_show_main_page() and
+ * eos_splash_page_manager_show_splash_page() to toggle between the two views.
+ * The splash screen will be shown by default until a call to
+ * eos_splash_page_manager_show_main_page() is made.
  */
 
 G_DEFINE_TYPE (EosSplashPageManager, eos_splash_page_manager, EOS_TYPE_PAGE_MANAGER)
@@ -115,7 +121,7 @@ eos_splash_page_manager_class_init (EosSplashPageManagerClass *klass)
                          G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
 
   /**
-   * EosPageManager:main-page:
+   * EosSplashPageManager:main-page:
    *
    * A reference to the main page widget of the splash page manager. If no
    * page has been set, points to null.
@@ -155,8 +161,8 @@ eos_splash_page_manager_new (void)
  * eos_splash_page_manager_get_splash_page:
  * @self: the splash page manager
  *
- * Gets a pointer to the splash page widget. See #EosSplashPageManager:splash-
- * page for more information.
+ * Gets a pointer to the splash page widget. See #EosSplashPageManager:splash-page
+ * for more information.
  *
  * Returns: (transfer none): the page #GtkWidget, or %NULL if the splash page
  * has not been set.
@@ -248,7 +254,7 @@ eos_splash_page_manager_set_main_page (EosSplashPageManager *self,
 }
 
 /**
- * eos_splash_page_manager_show_splash_page:
+ * eos_splash_page_manager_show_main_page:
  * @self: the splash page manager
  *
  * Shows the main page of the splash page manager.
@@ -271,7 +277,8 @@ eos_splash_page_manager_show_main_page (EosSplashPageManager *self)
  * @self: the splash page manager
  *
  * Shows the splash page. This page is shown first by default, so this only
- * has effect if you want to "reshow" the page after calling show_main_page.
+ * has effect if you want to "reshow" the page after calling
+ * eos_splash_page_manager_show_main_page().
  */
 void
 eos_splash_page_manager_show_splash_page (EosSplashPageManager *self)
diff --git a/test/run-tests.h b/test/run-tests.h
index 7606b09..dfd7d89 100644
--- a/test/run-tests.h
+++ b/test/run-tests.h
@@ -24,11 +24,11 @@ void app_window_test_fixture_test     (AppWindowTestFixture *fixture,
 void app_window_test_fixture_teardown (AppWindowTestFixture *fixture,
                                        gconstpointer unused);
 
-void add_init_tests                   (void);
-void add_hello_tests                  (void);
-void add_application_tests            (void);
-void add_window_tests                 (void);
-void add_page_manager_tests           (void);
+void add_init_tests                          (void);
+void add_hello_tests                         (void);
+void add_application_tests                   (void);
+void add_window_tests                        (void);
+void add_page_manager_tests                  (void);
 void add_splash_page_manager_tests           (void);
 
 #endif /* RUN_TESTS_H */