E57SimpleWriter: Add deprecation notice to old Writer constructor (#117)

asmaloney · Oct 4, 2022 · c6ec124 · c6ec124
1 parent abe95bc
commit c6ec124
Showing 1 changed file with 6 additions and 3 deletions.
diff --git a/include/E57SimpleWriter.h b/include/E57SimpleWriter.h
@@ -46,12 +46,15 @@ namespace e57
    {
    public:
       //! @brief This function is the constructor for the writer class
-      //! @param [in] filePath file path to E57 file
+      //! @param [in] filePath Path to E57 file
       //! @param [in] coordinateMetadata Information describing the Coordinate Reference System to be used for the file
-      Writer( const ustring &filePath, const ustring &coordinateMetadata = {} );
+      //! @deprecated Will be removed in 4.0. Use Writer( const ustring &filePath, const WriterOptions &options )
+      //! instead.
+      [[deprecated( "Will be removed in 4.0. Use Writer( ustring, WriterOptions )." )]] // TODO Remove in 4.0
+      explicit Writer( const ustring &filePath, const ustring &coordinateMetadata = {} );
 
       //! @brief This function is the constructor for the writer class
-      //! @param [in] filePath file path to E57 file
+      //! @param [in] filePath Path to E57 file
       //! @param [in] options Options to be used for the file
       Writer( const ustring &filePath, const WriterOptions &options );