From 4a5c1e8d50be84d7df0b38ff8e5c26541e9d81ca Mon Sep 17 00:00:00 2001 From: Dick Hollenbeck Date: Tue, 4 Jan 2011 12:53:11 -0600 Subject: [PATCH] doc fixes --- new/design.h | 14 ++++++++------ new/sch_dir_lib_source.h | 2 +- new/sch_lib.h | 2 +- new/sch_lib_table.h | 1 + new/sch_part.h | 4 ++-- 5 files changed, 13 insertions(+), 10 deletions(-) diff --git a/new/design.h b/new/design.h index 831af35534..eb08fdcd69 100644 --- a/new/design.h +++ b/new/design.h @@ -9,7 +9,7 @@ also, in the future. @author Dick Hollenbeck -@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 diff --git a/new/sch_dir_lib_source.h b/new/sch_dir_lib_source.h index b6336cfd9c..9444bb2f84 100644 --- a/new/sch_dir_lib_source.h +++ b/new/sch_dir_lib_source.h @@ -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 diff --git a/new/sch_lib.h b/new/sch_lib.h index 5dc32a2878..88a57cee48 100644 --- a/new/sch_lib.h +++ b/new/sch_lib.h @@ -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 diff --git a/new/sch_lib_table.h b/new/sch_lib_table.h index a1551b6ad6..c25f849dfb 100644 --- a/new/sch_lib_table.h +++ b/new/sch_lib_table.h @@ -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)) + * ) * * * When this function is called, the input token stream given by \a aLexer diff --git a/new/sch_part.h b/new/sch_part.h index 85319e875a..a3d6441d23 100644 --- a/new/sch_part.h +++ b/new/sch_part.h @@ -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 )