moved doc comments from impl to trait

Ecdar · Dec 11, 2023 · 9e3d85f · 9e3d85f
1 parent fc82aa4
commit 9e3d85f
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 12 deletions.
diff --git a/src/controllers/controller_impls/reveaal_controller.rs b/src/controllers/controller_impls/reveaal_controller.rs
@@ -25,14 +25,19 @@ impl EcdarBackend for ReveaalController {
     ) -> Result<Response<UserTokenResponse>, Status> {
         self.services.reveaal_service.get_user_token(request).await
     }
-
+    /// Forwards the query to the Reveaal backend
+    /// # Errors
+    /// Errors when Reveaal backend errors
     async fn send_query(
         &self,
         request: Request<QueryRequest>,
     ) -> Result<Response<QueryResponse>, Status> {
         self.services.reveaal_service.send_query(request).await
     }
-
+    /// Forwards the query to the Reveaal backend
+    /// # Errors
+    /// Errors when Reveaal backend errors
+    //TODO Bedre doc comment
     async fn start_simulation(
         &self,
         request: Request<SimulationStartRequest>,
@@ -42,7 +47,7 @@ impl EcdarBackend for ReveaalController {
             .start_simulation(request)
             .await
     }
-
+    //TODO Bedre doc comment
     async fn take_simulation_step(
         &self,
         request: Request<SimulationStepRequest>,

diff --git a/src/controllers/controller_impls/session_controller.rs b/src/controllers/controller_impls/session_controller.rs
@@ -80,9 +80,6 @@ impl SessionController {
 
 #[async_trait]
 impl SessionControllerTrait for SessionController {
-    /// Deletes the requester's session, found by their access token.
-    ///  
-    /// Returns the response that is received from Reveaal.
     async fn delete_session(&self, request: Request<()>) -> Result<Response<()>, Status> {
         let access_token = request
             .token_string()
@@ -105,12 +102,6 @@ impl SessionControllerTrait for SessionController {
         }
     }
 
-    /// This method is used to get a new access and refresh token for a user.
-    ///
-    /// # Errors
-    /// This function will return an error if the user does not exist in the contexts,
-    /// if the password in the request does not match the user's password,
-    /// or if no user is provided in the request.
     async fn get_auth_token(
         &self,
         request: Request<GetAuthTokenRequest>,

diff --git a/src/controllers/controller_traits/session_controller_trait.rs b/src/controllers/controller_traits/session_controller_trait.rs
@@ -4,7 +4,17 @@ use tonic::{Request, Response, Status};
 
 #[async_trait]
 pub trait SessionControllerTrait: Send + Sync {
+    /// Deletes the requester's session, found by their access token.
+    ///  
+    /// Returns the response that is received from Reveaal.
     async fn delete_session(&self, _request: Request<()>) -> Result<Response<()>, Status>;
+
+    /// This method is used to get a new access and refresh token for a user.
+    ///
+    /// # Errors
+    /// This function will return an error if the user does not exist in the contexts,
+    /// if the password in the request does not match the user's password,
+    /// or if no user is provided in the request.
     async fn get_auth_token(
         &self,
         request: Request<GetAuthTokenRequest>,