diff --git a/api/sixtyfps-rs/sixtyfps-macros/lib.rs b/api/sixtyfps-rs/sixtyfps-macros/lib.rs index b8d23b891..3b965e1fe 100644 --- a/api/sixtyfps-rs/sixtyfps-macros/lib.rs +++ b/api/sixtyfps-rs/sixtyfps-macros/lib.rs @@ -10,10 +10,13 @@ LICENSE END */ /*! -*NOTE*: This library is an internal crate for the [SixtyFPS project](https://sixtyfps.io). -This crate should not be used directly by application using SixtyFPS. +**NOTE**: This library is an **internal** crate for the [SixtyFPS project](https://sixtyfps.io). +This crate should **not be used directly** by applications using SixtyFPS. You should use the `sixtyfps` crate instead. +**WARNING**: This crate does not follow the semver convention for versioning and can +only be used with `version = "=x.y.z"` in Cargo.toml. + */ // cSpell:ignore punct diff --git a/sixtyfps_compiler/lib.rs b/sixtyfps_compiler/lib.rs index 1c0b29234..e075365ef 100644 --- a/sixtyfps_compiler/lib.rs +++ b/sixtyfps_compiler/lib.rs @@ -10,9 +10,12 @@ LICENSE END */ /*! # The SixtyFPS compiler library -**NOTE:** This library is an internal crate for the SixtyFPS project. -This crate should not be used directly by application using SixtyFPS. -You should use the `sixtyfps` crate instead +**NOTE**: This library is an **internal** crate for the [SixtyFPS project](https://sixtyfps.io). +This crate should **not be used directly** by applications using SixtyFPS. +You should use the `sixtyfps` crate instead. + +**WARNING**: This crate does not follow the semver convention for versioning and can +only be used with `version = "=x.y.z"` in Cargo.toml. */ diff --git a/sixtyfps_compiler/parser_test_macro/lib.rs b/sixtyfps_compiler/parser_test_macro/lib.rs index 343a57616..e86a98d5f 100644 --- a/sixtyfps_compiler/parser_test_macro/lib.rs +++ b/sixtyfps_compiler/parser_test_macro/lib.rs @@ -15,6 +15,13 @@ function, checking that no error are reported, and that everything was consumed A parser function must have the signature `fn(&mut impl Parser)` +**NOTE**: This library is an **internal** crate for the [SixtyFPS project](https://sixtyfps.io). +This crate should **not be used directly** by applications using SixtyFPS. +You should use the `sixtyfps` crate instead. + +**WARNING**: This crate does not follow the semver convention for versioning and can +only be used with `version = "=x.y.z"` in Cargo.toml. + */ extern crate proc_macro; diff --git a/sixtyfps_runtime/corelib/lib.rs b/sixtyfps_runtime/corelib/lib.rs index 9d5860e50..263029456 100644 --- a/sixtyfps_runtime/corelib/lib.rs +++ b/sixtyfps_runtime/corelib/lib.rs @@ -11,10 +11,13 @@ LICENSE END */ # SixtyFPS runtime library -*NOTE*: This library is an internal crate for the [SixtyFPS project](https://sixtyfps.io). -This crate should not be used directly by application using SixtyFPS. +**NOTE**: This library is an **internal** crate for the [SixtyFPS project](https://sixtyfps.io). +This crate should **not be used directly** by applications using SixtyFPS. You should use the `sixtyfps` crate instead. +**WARNING**: This crate does not follow the semver convention for versioning and can +only be used with `version = "=x.y.z"` in Cargo.toml. + */ #![doc(html_logo_url = "https://sixtyfps.io/resources/logo.drawio.svg")] #![deny(unsafe_code)] diff --git a/sixtyfps_runtime/corelib_macros/lib.rs b/sixtyfps_runtime/corelib_macros/lib.rs index 780dcf801..3c0e4956f 100644 --- a/sixtyfps_runtime/corelib_macros/lib.rs +++ b/sixtyfps_runtime/corelib_macros/lib.rs @@ -9,7 +9,15 @@ LICENSE END */ /*! This crate contains the internal procedural macros - used by the sixtyfps corelib crate + used by the sixtyfps-corelib crate + +**NOTE**: This library is an **internal** crate for the [SixtyFPS project](https://sixtyfps.io). +This crate should **not be used directly** by applications using SixtyFPS. +You should use the `sixtyfps` crate instead. + +**WARNING**: This crate does not follow the semver convention for versioning and can +only be used with `version = "=x.y.z"` in Cargo.toml. + */ extern crate proc_macro; diff --git a/sixtyfps_runtime/rendering_backends/default/lib.rs b/sixtyfps_runtime/rendering_backends/default/lib.rs index d270b690e..8096d3b31 100644 --- a/sixtyfps_runtime/rendering_backends/default/lib.rs +++ b/sixtyfps_runtime/rendering_backends/default/lib.rs @@ -8,16 +8,21 @@ Please contact info@sixtyfps.io for more information. LICENSE END */ /*! + +**NOTE**: This library is an **internal** crate for the [SixtyFPS project](https://sixtyfps.io). +This crate should **not be used directly** by applications using SixtyFPS. +You should use the `sixtyfps` crate instead. + +**WARNING**: This crate does not follow the semver convention for versioning and can +only be used with `version = "=x.y.z"` in Cargo.toml. + + The purpose of this crate is to select the default backend for [SixtyFPS](https://sixtyfps.io) The backend can either be a runtime or a build time decision. The runtime decision is decided by the `SIXTYFPS_BACKEND` environment variable. The built time default depends on the platform. In order for the crate to be available at runtime, they need to be added as feature -*NOTE*: This library is an internal crate for the [SixtyFPS project](https://sixtyfps.io). -This crate should not be used directly by application using SixtyFPS. -You should use the `sixtyfps` crate instead. - */ #![doc(html_logo_url = "https://sixtyfps.io/resources/logo.drawio.svg")] diff --git a/sixtyfps_runtime/rendering_backends/gl/lib.rs b/sixtyfps_runtime/rendering_backends/gl/lib.rs index 1044014eb..b3a226b61 100644 --- a/sixtyfps_runtime/rendering_backends/gl/lib.rs +++ b/sixtyfps_runtime/rendering_backends/gl/lib.rs @@ -9,10 +9,13 @@ LICENSE END */ /*! -*NOTE*: This library is an internal crate for the [SixtyFPS project](https://sixtyfps.io). -This crate should not be used directly by application using SixtyFPS. +**NOTE**: This library is an **internal** crate for the [SixtyFPS project](https://sixtyfps.io). +This crate should **not be used directly** by applications using SixtyFPS. You should use the `sixtyfps` crate instead. +**WARNING**: This crate does not follow the semver convention for versioning and can +only be used with `version = "=x.y.z"` in Cargo.toml. + */ #![doc(html_logo_url = "https://sixtyfps.io/resources/logo.drawio.svg")] diff --git a/sixtyfps_runtime/rendering_backends/qt/lib.rs b/sixtyfps_runtime/rendering_backends/qt/lib.rs index c595e2848..191e9cd67 100644 --- a/sixtyfps_runtime/rendering_backends/qt/lib.rs +++ b/sixtyfps_runtime/rendering_backends/qt/lib.rs @@ -10,10 +10,13 @@ LICENSE END */ /*! -*NOTE*: This library is an internal crate for the [SixtyFPS project](https://sixtyfps.io). -This crate should not be used directly by application using SixtyFPS. +**NOTE**: This library is an **internal** crate for the [SixtyFPS project](https://sixtyfps.io). +This crate should **not be used directly** by applications using SixtyFPS. You should use the `sixtyfps` crate instead. +**WARNING**: This crate does not follow the semver convention for versioning and can +only be used with `version = "=x.y.z"` in Cargo.toml. + */ #![doc(html_logo_url = "https://sixtyfps.io/resources/logo.drawio.svg")] #![recursion_limit = "1024"]