diff --git a/docs/io/input.rst b/docs/io/input.rst index 4d4b05375..10696ebd5 100644 --- a/docs/io/input.rst +++ b/docs/io/input.rst @@ -41,6 +41,9 @@ Gate-level Layouts .. autofunction:: mnt.pyfiction.read_shifted_cartesian_fgl_layout .. autofunction:: mnt.pyfiction.read_hexagonal_fgl_layout + .. autoclass:: mnt.pyfiction.fgl_parsing_error + :members: + Cell-level Layouts ################## diff --git a/include/fiction/io/read_fgl_layout.hpp b/include/fiction/io/read_fgl_layout.hpp index e84440f7a..3c88028b3 100644 --- a/include/fiction/io/read_fgl_layout.hpp +++ b/include/fiction/io/read_fgl_layout.hpp @@ -37,7 +37,7 @@ class fgl_parsing_error : public std::runtime_error { public: /** - * Constructs a fgl_parsing_error object with the given error message. + * Constructs a `fgl_parsing_error` object with the given error message. * * @param msg The error message describing the parsing error. */ @@ -714,7 +714,7 @@ class read_fgl_layout_impl /** * Reads a gate-level layout from an FGL file provided as an input stream. * - * May throw an `fgl_parsing_exception` if the FGL file is malformed. + * May throw an `fgl_parsing_error` if the FGL file is malformed. * * @tparam Lyt The layout type to be created from an input. * @param is The input stream to read from. @@ -734,9 +734,9 @@ template /** * Reads a gate-level layout from an FGL file provided as an input stream. * - * May throw an `fgl_parsing_exception` if the FGL file is malformed. + * May throw an `fgl_parsing_error` if the FGL file is malformed. * - * This is an in-place version of read_fgl_layout that utilizes the given layout as a target to write to. + * This is an in-place version of `read_fgl_layout` that utilizes the given layout as a target to write to. * * @tparam Lyt The layout type to be used as input. * @param lyt The layout to write to. @@ -754,7 +754,7 @@ void read_fgl_layout(Lyt& lyt, std::istream& is) /** * Reads a gate-level layout from an FGL file provided as an input stream. * - * May throw an `fgl_parsing_exception` if the FGL file is malformed. + * May throw an `fgl_parsing_error` if the FGL file is malformed. * * @tparam Lyt The layout type to be created from an input. * @param filename The file name to open and read from. @@ -778,7 +778,7 @@ template /** * Reads a gate-level layout from an FGL file provided as an input stream. * - * May throw an `fgl_parsing_exception` if the FGL file is malformed. + * May throw an `fgl_parsing_error` if the FGL file is malformed. * * This is an in-place version of `read_fgl_layout` that utilizes the given layout as a target to write to. *