haskal
/
kicad
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc fixes

This commit is contained in:
Dick Hollenbeck 2011-01-04 12:53:11 -06:00
parent 26be6d0152
commit 4a5c1e8d50
5 changed files with 13 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
new/design.h
View File

@ -9,7 +9,7 @@ also, in the future.
@author Dick Hollenbeck <dick@softplc.com> @author Dick Hollenbeck <dick@softplc.com>
@date October-December 2010 @date October 2010 - January 2011
@section intr_sec Introduction @section intr_sec Introduction
@ -370,10 +370,10 @@ class HTTP_LIB_SOURCE : public LIB_SOURCE
protected: protected:
/** /**
* Constructor ( const STRING& aSvnURL ) * Constructor ( const STRING& aHttpURL )
* sets up a LIB_SOURCE using aSvnURI which points to a subversion * sets up a LIB_SOURCE using aHttpURI which points to a subversion
* repository. * repository.
* @see LIBS::GetLibrary(). * @see LIB_TABLE::LookupPart()
* *
* @param aHttpURL is a full URL of a document root repo directory. Example might * @param aHttpURL is a full URL of a document root repo directory. Example might
* be "http://kicad.org/libs" * be "http://kicad.org/libs"
@ -401,7 +401,7 @@ protected:
* Constructor SVN_LIB_SOURCE( const STRING& aSvnURL ) * Constructor SVN_LIB_SOURCE( const STRING& aSvnURL )
* sets up a LIB_SOURCE using aSvnURI which points to a subversion * sets up a LIB_SOURCE using aSvnURI which points to a subversion
* repository. * repository.
* @see LIBS::GetLibrary(). * @see LIB_TABLE::LookupPart().
* *
* @param aSvnURL is a full URL of a subversion repo directory. Example might * @param aSvnURL is a full URL of a subversion repo directory. Example might
* be "svn://kicad.org/repos/library/trunk" * 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 * 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 * for a schematic not related to the schematic being editing in
* this EESCHEMA session. * this EESCHEMA session.
* @see LIBS::GetLibrary(). * @see LIB_TABLE::LookupPart().
* *
* @param aSchematicFile is a full path and filename. Example: * @param aSchematicFile is a full path and filename. Example:
* "/home/user/kicadproject/design.sch" * "/home/user/kicadproject/design.sch"
@ -471,4 +471,6 @@ public:
/// @todo add simple unit test infrastructure. /// @todo add simple unit test infrastructure.
/// @todo review: http://www.sfml-dev.org/tutorials/1.2/graphics-wxwidgets.php
// EOF // EOF

2
new/sch_dir_lib_source.h
View File

@ -144,7 +144,7 @@ protected:
/** /**
* Constructor DIR_LIB_SOURCE( const STRING& aDirectoryPath ) * Constructor DIR_LIB_SOURCE( const STRING& aDirectoryPath )
* sets up a LIB_SOURCE using aDirectoryPath in a file system. * 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 * @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 * the library source of part files. Examples might be "C:\kicad_data\mylib" or

2
new/sch_lib.h
View File

@ -46,7 +46,7 @@ class LIB_TABLE;
*/ */
class LIB_SOURCE 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. friend class LIB; ///< the LIB uses these functions.
protected: ///< derived classes must implement protected: ///< derived classes must implement

1
new/sch_lib_table.h
View File

@ -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)) * (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> * </pre>
* *
* When this function is called, the input token stream given by \a aLexer * When this function is called, the input token stream given by \a aLexer

4
new/sch_part.h
View File

@ -145,10 +145,10 @@ public:
* *
* @param aLexer is an instance of SWEET_LEXER, rewound at the first line. * @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. * 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 ) void SetBody( const STR_UTF& aSExpression )