hide internal types from rustdoc (#1432)

Author: OmarTawfik

crates/codegen/runtime/cargo/crate/src/runtime/bindings/mod.rs

@@ -52,7 +52,7 @@ pub type UserFileLocation = metaslang_bindings::UserFileLocation<KindTypes>;
 pub type BuiltInLocation = metaslang_bindings::BuiltInLocation;
 
 #[cfg(feature = "__private_testing_utils")]
-#[allow(missing_docs)]
+#[doc(hidden)]
 // Create a new `BindingGraphBuilder` with the specified language version and resolver.
 // Exposed to test the functionality, but users should use the `CompilationBuilder` instead.
 pub fn create_with_resolver(
@@ -78,7 +78,7 @@ pub(crate) fn create_with_resolver_internal(
 }
 
 #[cfg(feature = "__private_testing_utils")]
-#[allow(missing_docs)]
+#[doc(hidden)]
 pub fn get_binding_rules() -> &'static str {
     binding_rules::BINDING_RULES_SOURCE
 }

crates/codegen/runtime/cargo/crate/src/runtime/cst/mod.rs

@@ -21,20 +21,21 @@ pub use nonterminal_kind::NonterminalKind;
 pub use rewriter::BaseRewriter;
 pub use terminal_kind::TerminalKind;
 
-// These derives are because default #[derive(...)] on a generic type implements only the trait
-// with default bounds also implied for the generic types as well, i.e.
-//
-// #[derive(Clone)] // expands to `impl<T: Clone> Clone for MyOption<T> { ... }` (notice the `T: Clone`)
-// struct MyOption<T>(Option<T>);
-//
-// This assumes that the underlying data type uses this internally, however it's only used as a
-// type container/marker.
-//
-// A slightly more "correct" approach would be to implement the traits while skipping the bounds for
-// the type marker, however this can be more noisy
-#[allow(missing_docs)]
+/// The base type of all nonterminals, terminals, and edges.
 #[derive(Clone, Debug, PartialEq, Eq, serde::Serialize)]
-pub enum KindTypes {}
+pub enum KindTypes {
+    // These derives are because default #[derive(...)] on a generic type implements only the trait
+    // with default bounds also implied for the generic types as well, i.e.
+    //
+    // #[derive(Clone)] // expands to `impl<T: Clone> Clone for MyOption<T> { ... }` (notice the `T: Clone`)
+    // struct MyOption<T>(Option<T>);
+    //
+    // This assumes that the underlying data type uses this internally, however it's only used as a
+    // type container/marker.
+    //
+    // A slightly more "correct" approach would be to implement the traits while skipping the bounds for
+    // the type marker, however this can be more noisy
+}
 
 impl metaslang_cst::kinds::KindTypes for KindTypes {
     type NonterminalKind = NonterminalKind;

crates/codegen/runtime/cargo/crate/src/runtime/mod.rs

@@ -2,7 +2,7 @@ pub mod bindings;
 pub mod compilation;
 pub mod cst;
 #[cfg(feature = "__private_ariadne_errors")]
-#[allow(missing_docs)]
+#[doc(hidden)]
 pub mod diagnostic;
 pub mod parser;
 pub mod utils;

crates/metaslang/bindings/generated/public_api.txt

@@ -74,7 +74,7 @@ impl<KT: KindTypes + 'static> Definition<KT> {
 }
 
 #[cfg(feature = "__private_testing_utils")]
-#[allow(missing_docs)]
+#[doc(hidden)]
 impl<KT: KindTypes + 'static> Definition<KT> {
     pub fn get_cursor(&self) -> &Cursor<KT> {
         self.internal_get_cursor()

crates/metaslang/bindings/src/graph/definition.rs

@@ -87,7 +87,7 @@ impl<KT: KindTypes + 'static> BindingGraph<KT> {
 }
 
 #[cfg(feature = "__private_testing_utils")]
-#[allow(missing_docs)]
+#[doc(hidden)]
 impl<KT: KindTypes + 'static> BindingGraph<KT> {
     pub fn all_definitions(self: &Rc<Self>) -> impl Iterator<Item = Definition<KT>> + '_ {
         self.graph.iter_definitions().map(|handle| Definition {

crates/metaslang/bindings/src/graph/mod.rs

@@ -58,7 +58,7 @@ impl<KT: KindTypes + 'static> Reference<KT> {
 }
 
 #[cfg(feature = "__private_testing_utils")]
-#[allow(missing_docs)]
+#[doc(hidden)]
 impl<KT: KindTypes + 'static> Reference<KT> {
     pub fn get_cursor(&self) -> &Cursor<KT> {
         self.internal_get_cursor()

crates/metaslang/bindings/src/graph/reference.rs

@@ -4,11 +4,11 @@
 //!
 //! It's based on the [stack graph library](https://docs.rs/stack-graphs/latest/stack_graphs/index.html).
 
-// This module is not part of the public API.
-#[allow(missing_docs)]
+#[doc(hidden)]
 mod builder;
 mod graph;
 
+#[doc(hidden)]
 pub use builder::{
     BindingGraphBuilder, FileGraphBuilder, GraphHandle, PathResolver, ScopeGraphBuilder,
 };

crates/metaslang/bindings/src/lib.rs

@@ -59,11 +59,11 @@ pub trait EdgeLabelExtensions: BaseKind + Default {}
 
 /// The base type of all nonterminals, terminals, and edges.
 pub trait KindTypes: std::fmt::Debug + Clone + PartialEq {
-    #[allow(missing_docs)]
+    /// The enum type representing nonterminal kinds.
     type NonterminalKind: NonterminalKindExtensions;
-    #[allow(missing_docs)]
+    /// The enum type representing terminal kinds.
     type TerminalKind: TerminalKindExtensions;
-    #[allow(missing_docs)]
+    /// The enum type representing edge labels.
     type EdgeLabel: EdgeLabelExtensions;
 }
 

crates/metaslang/cst/src/kinds.rs

@@ -1,5 +1,3 @@
-#![allow(missing_docs)]
-
 pub mod l1_structured_ast;
 pub mod l2_flat_contracts;