Commit 793f70ba authored by Hiroshi Sumita's avatar Hiroshi Sumita
Browse files

Fixes some error related to API documents. 

BUG=Some documents are wrong.
TEST=Manual

Review URL: https://codereview.appspot.com/6227043
parent 155a5a8b

docs/Makefile.am

+2 −6
Original line number Diff line number Diff line
@@ -20,11 +20,6 @@ 
# USA



if HAVE_DOXYGEN

directory = $(top_srcdir)/docs/man/man3/



dist_man_MANS = $(directory)/man_page_1.3 $(directory)/man_page_2.3

$(directory)/man_page_1.3: doxyfile.stamp

$(directory)/man_page_2.3: doxyfile.stamp



doxyfile.stamp:

	$(DOXYGEN) Doxyfile
@@ -33,6 +28,7 @@ doxyfile.stamp: 
CLEANFILES = doxyfile.stamp



all-local: doxyfile.stamp



clean-local:

	rm -rf $(top_srcdir)/docs/man

	rm -rf $(top_srcdir)/docs/html

endif

src/PyZyInputContext.h

+1 −3
Original line number Diff line number Diff line
@@ -301,14 +301,12 @@ public: 


    /**

     * \brief Focuses a previous candidate.

     * @param index Index of the candidate. (0-origin)

     * @return true if focused index is changed.

     */

    virtual bool focusCandidatePrevious (void) = 0;



    /**

     * \brief Focuses a next candidate.

     * @param index Index of the candidate. (0-origin)

     * @return true if there are some candidates after the focused candidate;

     *           false otherwise.

     */
@@ -446,7 +444,7 @@ public: 
    /**

     * \brief Sets property of the context.

     * @param name you want to get.

     * @variant value of the property.

     * @param variant value of the property.

     * @return true if the value is set successfully.

     */

    virtual bool setProperty (PropertyName name, const Variant &variant)= 0;

src/PyZyVariant.h

+2 −3
Original line number Diff line number Diff line
@@ -43,21 +43,20 @@ public: 


    /**

     * \brief Creates a Variant object from the argument.

     * @value boolean value.

     * @param value boolean value.

     * @return Variant object.

     */

    static Variant fromBool (bool value);



    /**

     * \brief Creates a Variant object from the argument.

     * @value unsigned int value.

     * @param value unsigned int value.

     * @return Variant object.

     */

    static Variant fromUnsignedInt (unsigned int value);



    /**

     * \brief Creates a null Variant object.

     * @value unsigned int value.

     * @return Variant object.

     */

    static Variant nullVariant (void);