Fixes doc

rust/agama-lib/src/network/client.rs

@@ -8,7 +8,7 @@ use super::proxies::IPv4Proxy;
 use super::proxies::WirelessProxy;
 use zbus::Connection;
 
-// D-BUS client for the network service
+/// D-BUS client for the network service
 pub struct NetworkClient<'a> {
     pub connection: Connection,
     connections_proxy: ConnectionsProxy<'a>,
@@ -22,7 +22,7 @@ impl<'a> NetworkClient<'a> {
         })
     }
 
-    // Returns an array of network connections
+    /// Returns an array of network connections
     pub async fn connections(&self) -> Result<Vec<NetworkConnection>, ServiceError> {
         let connection_paths = self.connections_proxy.get_connections().await?;
         let mut connections = vec![];
@@ -40,9 +40,9 @@ impl<'a> NetworkClient<'a> {
         Ok(connections)
     }
 
-    // It returns the NetworkConnection for the given connection path
-    //
-    //  * `path`: the connections path to get the config from
+    /// Returns the NetworkConnection for the given connection path
+    ///
+    ///  * `path`: the connections path to get the config from
     async fn connection_from(&self, path: &str) -> Result<NetworkConnection, ServiceError> {
         let connection_proxy = ConnectionProxy::builder(&self.connection)
             .path(path)?
@@ -55,7 +55,7 @@ impl<'a> NetworkClient<'a> {
             .build()
             .await?;
 
-        // TODO: consider using the `IPMethod` struct from `agama-network`.
+        /// TODO: consider using the `IPMethod` struct from `agama-network`.
         let method = match ipv4_proxy.method().await? {
             0 => "auto",
             1 => "manual",
@@ -84,9 +84,9 @@ impl<'a> NetworkClient<'a> {
         })
     }
 
-    // Returns the [wireless settings][WirelessSettings] for the given connection
-    //
-    //  * `path`: the connections path to get the wireless config from
+    /// Returns the [wireless settings][WirelessSettings] for the given connection
+    ///
+    ///  * `path`: the connections path to get the wireless config from
     async fn wireless_from(&self, path: &str) -> Result<WirelessSettings, ServiceError> {
         let wireless_proxy = WirelessProxy::builder(&self.connection)
             .path(path)?