realAscot/kicad-source
1
0
Fork 0
mirror of https://gitlab.com/kicad/code/kicad.git synced 2025-09-14 02:03:12 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add a bit of documentation to help future us

Browse Source
This commit is contained in:
Seth Hillbrand 2025-07-16 16:39:10 -07:00
parent 9f903a2661
commit 9d770fe243
2 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
eeschema/sch_sheet.cpp
View File

@ -1442,13 +1442,13 @@ const SCH_SHEET_INSTANCE& SCH_SHEET::GetRootInstance() const
} }
wxString SCH_SHEET::getPageNumber( const KIID_PATH& aPath ) const wxString SCH_SHEET::getPageNumber( const KIID_PATH& aParentPath ) const
{ {
wxString pageNumber; wxString pageNumber;
for( const SCH_SHEET_INSTANCE& instance : m_instances ) for( const SCH_SHEET_INSTANCE& instance : m_instances )
{ {
if( instance.m_Path == aPath ) if( instance.m_Path == aParentPath )
{ {
pageNumber = instance.m_PageNumber; pageNumber = instance.m_PageNumber;
break; break;

5
eeschema/sch_sheet.h
View File

@ -501,14 +501,15 @@ protected:
bool addInstance( const KIID_PATH& aInstance ); bool addInstance( const KIID_PATH& aInstance );
/** /**
* Return the sheet page number for \a aInstance. * Return the sheet page number for \a aParentPath.
* *
* @warning The #KIID_PATH object must be a full hierarchical path which means the sheet * @warning The #KIID_PATH object must be a full hierarchical path which means the sheet
* at index 0 must be the root sheet. * at index 0 must be the root sheet.
* @param aParentPath is the hierarchical path of the sheet that contains an instance of this SCH_SHEET
* *
* @return the page number for the requested sheet instance. * @return the page number for the requested sheet instance.
*/ */
wxString getPageNumber( const KIID_PATH& aInstance ) const; wxString getPageNumber( const KIID_PATH& aParentPath ) const;
/** /**
* Set the page number for the sheet instance \a aInstance. * Set the page number for the sheet instance \a aInstance.