Skip to content
This repository has been archived by the owner on Nov 26, 2020. It is now read-only.

Commit

Permalink
Improved doc comments
Browse files Browse the repository at this point in the history
Style guide compliance, a summary line for the top-level comment
  • Loading branch information
mzabaluev committed Oct 23, 2015
1 parent 09c57fb commit 3aeb12e
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions gtypes.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA


//! Fundamental types for GLib and GObject introspection.
//!
//! This crate provides definitions for types that are intrinsic in
//! GObject introspection, unlike all other types that have a definition in
//! a GIR file. All crates generated from GObject introspection data should
Expand All @@ -38,19 +39,18 @@ extern crate libc;
// the Python module giscanner.ast, part of gobject-introspection tools:
// https://git.gnome.org/browse/gobject-introspection/tree/giscanner/ast.py

/// Definitions for primitive fundamental types.
///
/// Values of these types don't have associated semantics or state
/// that would necessitate some kind of wrapper types in safe Rust
/// bindings. Therefore, these types can be used in both
/// FFI declarations and idiomatic Rust bindings, unlikely to require
/// name disambiguation with any generated or binding types.
///
/// The untyped pointer types are also defined in this module,
/// because safe Rust bindings are unlikely to need to reuse their names.
pub mod primitive {

//! Definitions for primitive fundamental types.
//!
//! Values of these types don't have associated semantics or state
//! that would necessitate some kind of wrapper types in safe Rust
//! bindings. Therefore, these types can be used in both
//! FFI declarations and idiomatic Rust bindings, unlikely to require
//! name disambiguation with any generated or binding types.
//!
//! The untyped pointer types are also defined in this module,
//! because safe Rust bindings are unlikely to need to reuse their names.
#![allow(non_camel_case_types)]

use libc;
Expand Down

0 comments on commit 3aeb12e

Please sign in to comment.