Merge pull request #135 from nanocoh/main

Doc for Clone + SetModel
najaeda · Oct 31, 2024 · e87b31b · e87b31b
2 parents 472c5e3 + 166a3bb
commit e87b31b
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 0 deletions.
diff --git a/src/snl/snl/kernel/SNLDesign.h b/src/snl/snl/kernel/SNLDesign.h
@@ -239,9 +239,31 @@ class SNLDesign final: public SNLObject {
     ///\return true if this SNLDesign is a top design.
     bool isTopDesign() const;
 
+    /**
+     * \brief Cloning interface for SNLDesign.
+     * \param name SNLName of the the clone.
+     * \return a new SNLDesign with the same interface as this SNLDesign.
+     */
     SNLDesign* cloneInterface(const SNLName& name=SNLName()) const;
+    /**
+     * \brief Cloning interface for SNLDesign to a specific SNLLibrary.
+     * \param library SNLLibrary where the clone will be created.
+     * \param name SNLName of the the clone.
+     * \return a new SNLDesign with the same interface as this SNLDesign.
+     */
     SNLDesign* cloneInterfaceToLibrary(SNLLibrary* library, const SNLName& name=SNLName()) const;
+    /**
+     * \brief Cloning for SNLDesign.
+     * \param name SNLName of the the clone.
+     * \return a new SNLDesign with the same interface and content as this SNLDesign.
+     */
     SNLDesign* clone(const SNLName& name=SNLName()) const;
+    /**
+     * \brief Cloning for SNLDesign to a specific SNLLibrary.
+     * \param library SNLLibrary where the clone will be created.
+     * \param name SNLName of the the clone.
+     * \return a new SNLDesign with the same interface and content as this SNLDesign.
+     */
     SNLDesign* cloneToLibrary(SNLLibrary* library, const SNLName& name=SNLName()) const;
 
     class CompareType {

diff --git a/src/snl/snl/kernel/SNLInstance.h b/src/snl/snl/kernel/SNLInstance.h
@@ -138,6 +138,10 @@ class SNLInstance final: public SNLDesignObject {
       SNLNet* net,
       SNLID::Bit netMSB, SNLID::Bit netLSB);
 
+    /**
+     * \brief Seting new model for this instance.
+     * \param newModel new model for this instance.
+     */
     void setModel(SNLDesign* newModel);
 
     SNLID::DesignObjectID getOrderID() const { return orederID_; }