From 0d3519fe7957dbb997a6a2b50d27ba3ea958af3a Mon Sep 17 00:00:00 2001 From: Adriaan de Groot Date: Tue, 24 Oct 2023 15:14:08 +0200 Subject: [PATCH] libcalamares: tidy up API documentation The __attribute__ on the namespace confuses clang-tidy, which is why this one namespace is indented. --- src/libcalamares/python/Api.h | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/libcalamares/python/Api.h b/src/libcalamares/python/Api.h index deb8c32c6..df8552b36 100644 --- a/src/libcalamares/python/Api.h +++ b/src/libcalamares/python/Api.h @@ -33,7 +33,7 @@ namespace Python __attribute__( ( visibility( "hidden" ) ) ) void debug( const std::string& s ); void warning( const std::string& s ); - // void warn( const std::string& s) is an alias of warning() + // void warn( const std::string& s) is an alias of warning() defined at the Python level void error( const std::string& s ); Dictionary load_yaml( const std::string& path ); @@ -48,12 +48,12 @@ namespace Python __attribute__( ( visibility( "hidden" ) ) ) int target_env_process_output( const List& args, const Object& callback, const std::string& input, int timeout ); int host_env_process_output( const List& args, const Object& callback, const std::string& input, int timeout ); - class Job; + /** @brief Proxy class in Python for the Calamares Job class -* -* This is available as libcalamares.job in Python code. -*/ + * + * This is available as libcalamares.job in Python code. + */ class JobProxy { public: