Commit 4a5c1e8d authored by Dick Hollenbeck's avatar Dick Hollenbeck
Browse files

doc fixes

parent 26be6d01

new/design.h

+8 −6
Original line number Diff line number Diff line
@@ -9,7 +9,7 @@ also, in the future. 


@author Dick Hollenbeck <dick@softplc.com>



@date   October-December 2010

@date   October 2010 - January 2011



@section intr_sec Introduction
@@ -370,10 +370,10 @@ class HTTP_LIB_SOURCE : public LIB_SOURCE 
protected:



    /**

     * Constructor ( const STRING& aSvnURL )

     * sets up a LIB_SOURCE using aSvnURI which points to a subversion

     * Constructor ( const STRING& aHttpURL )

     * sets up a LIB_SOURCE using aHttpURI which points to a subversion

     * repository.

     * @see LIBS::GetLibrary().

     * @see LIB_TABLE::LookupPart()

     *

     * @param aHttpURL is a full URL of a document root repo directory.  Example might

     *  be "http://kicad.org/libs"
@@ -401,7 +401,7 @@ protected: 
     * Constructor SVN_LIB_SOURCE( const STRING& aSvnURL )

     * sets up a LIB_SOURCE using aSvnURI which points to a subversion

     * repository.

     * @see LIBS::GetLibrary().

     * @see LIB_TABLE::LookupPart().

     *

     * @param aSvnURL is a full URL of a subversion repo directory.  Example might

     *  be "svn://kicad.org/repos/library/trunk"
@@ -430,7 +430,7 @@ protected: 
     * sets up a LIB_SOURCE using aSchematicFile which is a full path and filename

     * for a schematic not related to the schematic being editing in

     * this EESCHEMA session.

     * @see LIBS::GetLibrary().

     * @see LIB_TABLE::LookupPart().

     *

     * @param aSchematicFile is a full path and filename.  Example:

     *  "/home/user/kicadproject/design.sch"
@@ -471,4 +471,6 @@ public: 


/// @todo add simple unit test infrastructure.



/// @todo review: http://www.sfml-dev.org/tutorials/1.2/graphics-wxwidgets.php



// EOF

new/sch_dir_lib_source.h

+1 −1
Original line number Diff line number Diff line
@@ -144,7 +144,7 @@ protected: 
    /**

     * Constructor DIR_LIB_SOURCE( const STRING& aDirectoryPath )

     * sets up a LIB_SOURCE using aDirectoryPath in a file system.

     * @see LIBS::GetLibrary().

     * @see LIB_TABLE::LookupPart().

     *

     * @param aDirectoryPath is a full file pathname of a directory which contains

     *  the library source of part files.  Examples might be "C:\kicad_data\mylib" or

new/sch_lib.h

+1 −1
Original line number Diff line number Diff line
@@ -46,7 +46,7 @@ class LIB_TABLE; 
 */

class LIB_SOURCE

{

    friend class LIBS;      ///< the LIB factory is LIBS::GetLibrary()

    friend class LIBS;      ///< the LIB factory is thru LIB_TABLE::LookupPart()

    friend class LIB;       ///< the LIB uses these functions.



protected:                  ///< derived classes must implement

new/sch_lib_table.h

+1 −0
Original line number Diff line number Diff line
@@ -223,6 +223,7 @@ public: 
     *   (lib (logical LOGICAL)(type TYPE)(full_uri FULL_URI)(options OPTIONS))

     *   (lib (logical LOGICAL)(type TYPE)(full_uri FULL_URI)(options OPTIONS))

     *   (lib (logical LOGICAL)(type TYPE)(full_uri FULL_URI)(options OPTIONS))

     *  )

     * </pre>

     *

     * When this function is called, the input token stream given by \a aLexer

new/sch_part.h

+2 −2
Original line number Diff line number Diff line
@@ -145,10 +145,10 @@ public: 
     *

     * @param aLexer is an instance of SWEET_LEXER, rewound at the first line.

     *

     * @param aLibTable is the LIB_TABLE view that is in effect for inheritance,

     * @param aLibTable is the LIB_TABLE "view" that is in effect for inheritance,

     *  and comes from the big containing SCHEMATIC object.

     */

    void Parse( SWEET_LEXER* aLexer, LIB_TABLE* aTable ) throw( IO_ERROR );

    void Parse( SWEET_LEXER* aLexer, LIB_TABLE* aLibTable ) throw( IO_ERROR );



/*

    void SetBody( const STR_UTF& aSExpression )