Added some doc comments

Author: Heliozoa

crates/bindings/tmc-langs-node/src/bin/generate-bindings.rs

@@ -1,3 +1,5 @@
+//! Exports TypeScript bindings.
+
 use std::fs::File;
 
 fn main() {

crates/bindings/tmc-langs-node/src/error.rs

@@ -1,3 +1,5 @@
+//! Contains the Error type.
+
 use serde::{de, ser};
 use std::{convert::From, fmt::Display};
 

crates/bindings/tmc-langs-node/src/helpers.rs

@@ -1,3 +1,5 @@
+//! Contains helper functions for getting Rust types from neon arguments.
+
 use neon::{prelude::*, result::Throw};
 use serde::Serialize;
 use std::error::Error;

crates/bindings/tmc-langs-node/src/lib.rs

@@ -1,3 +1,5 @@
+//! Node bindings to tmc-langs-rust.
+
 mod de;
 mod error;
 mod helpers;

crates/bindings/tmc-langs-node/src/ser.rs

@@ -1,6 +1,4 @@
-//!
 //! Serialize a Rust data structure into a `JsValue`
-//!
 
 use crate::error::{Error, Result as LibResult};
 use neon::{prelude::*, types::buffer::TypedArray};

crates/plugins/python3/src/error.rs

@@ -1,4 +1,4 @@
-// Python plugin error type
+//! Python plugin error type
 
 use std::path::PathBuf;
 use thiserror::Error;

crates/plugins/python3/src/python_test_result.rs

@@ -1,3 +1,5 @@
+//! Contains the PythonTestResult type.
+
 use serde::{Deserialize, Serialize};
 use std::collections::HashSet;
 use tmc_langs_framework::TestResult;

crates/tmc-client/src/tmc_client.rs

@@ -1,4 +1,5 @@
 //! Contains the TmcClient struct for communicating with the TMC server.
+
 pub mod api_v8;
 
 use self::api_v8::{PasteData, ReviewData};

crates/tmc-client/src/tmc_client/api_v8.rs

@@ -1,5 +1,7 @@
 #![allow(dead_code)]
 
+//! Models the API of https://tmc.mooc.fi (https://testmycode.github.io/tmc-server/).
+
 use crate::{request::*, response::*, ClientError, TmcClient};
 use http::Method;
 use oauth2::TokenResponse;

crates/tmc-langs-cli/src/error.rs

@@ -1,3 +1,5 @@
+//! Contains various error types.
+
 use std::path::PathBuf;
 use thiserror::Error;
 use tmc_langs::ExerciseDownload;