doc: update prior to release (#145)

* doc: point links to 2024 version
* doc: make version docs consistent
* doc: hide internal macros
* doc: tweak order of external links for consistency
* doc: use actual OpenVINO names
* doc: tweak version doc string

Author: abrown

crates/openvino/src/core.rs

@@ -1,5 +1,5 @@
 //! Define the core interface between Rust and OpenVINO's C
-//! [API](https://docs.openvino.ai/2023.3/api/c_cpp_api/group__ov__core__c__api.html).
+//! [API](https://docs.openvino.ai/2024/api/c_cpp_api/group__ov__core__c__api.html).
 
 use crate::error::LoadingError;
 use crate::{cstr, drop_using_function, try_unsafe, util::Result};
@@ -16,7 +16,7 @@ use std::os::raw::c_char;
 use std::slice;
 use std::str::FromStr;
 
-/// See [`Core`](https://docs.openvino.ai/2024/api/c_cpp_api/group__ov__core__c__api.html).
+/// See [`ov_core_t`](https://docs.openvino.ai/2024/api/c_cpp_api/group__ov__core__c__api.html).
 pub struct Core {
     ptr: *mut ov_core_t,
 }

crates/openvino/src/device_type.rs

@@ -13,7 +13,7 @@ pub enum DeviceType<'a> {
     GPU,
     /// [NPU Device](https://docs.openvino.ai/2024/openvino-workflow/running-inference/inference-devices-and-modes/npu-device.html)
     NPU,
-    /// [GNA Device](https://docs.openvino.ai/2023.3/openvino_docs_OV_UG_supported_plugins_GNA.html)
+    /// [GNA Device](https://docs.openvino.ai/2024/openvino_docs_OV_UG_supported_plugins_GNA.html)
     #[deprecated = "Deprecated since OpenVINO 2024.0; use NPU device instead"]
     GNA,
     /// Arbitrary device.

crates/openvino/src/dimension.rs

@@ -1,6 +1,7 @@
 use openvino_sys::{ov_dimension_is_dynamic, ov_dimension_t};
 
-/// See [`Dimension`](https://docs.openvino.ai/2023.3/api/c_cpp_api/group__ov__dimension__c__api.html).
+/// See
+/// [`ov_dimension_t`](https://docs.openvino.ai/2024/api/c_cpp_api/group__ov__dimension__c__api.html).
 #[derive(Copy, Clone, Debug)]
 #[repr(transparent)]
 pub struct Dimension {

crates/openvino/src/element_type.rs

@@ -12,7 +12,8 @@ use std::convert::TryFrom;
 use std::error::Error;
 use std::fmt;
 
-/// `ElementType` represents the type of elements that a tensor can hold. See [`ElementType`](https://docs.openvino.ai/2023.3/api/c_cpp_api/group__ov__base__c__api.html#_CPPv417ov_element_type_e).
+/// See
+/// [`ov_element_type_e`](https://docs.openvino.ai/2024/api/c_cpp_api/group__ov__base__c__api.html#_CPPv417ov_element_type_e).
 #[derive(Clone, Copy, Debug, PartialEq, Eq)]
 #[repr(u32)]
 pub enum ElementType {

crates/openvino/src/error.rs

@@ -1,8 +1,9 @@
 use std::error::Error;
 use std::fmt;
 
-/// Enumerate errors returned by the OpenVINO implementation. See
-/// [`OvStatusCode`](https://docs.openvino.ai/2023.3/api/c_cpp_api/group__ov__base__c__api.html#_CPPv411ov_status_e).
+/// See
+/// [`ov_status_e`](https://docs.openvino.ai/2024/api/c_cpp_api/group__ov__base__c__api.html#_CPPv411ov_status_e);
+/// enumerates errors returned by the OpenVINO implementation.
 #[allow(missing_docs)]
 #[derive(Debug, PartialEq, Eq)]
 pub enum InferenceError {

crates/openvino/src/layout.rs

@@ -1,7 +1,7 @@
 use crate::{cstr, drop_using_function, try_unsafe, util::Result};
 use openvino_sys::{ov_layout_create, ov_layout_free, ov_layout_t};
 
-/// See [`Layout`](https://docs.openvino.ai/2023.3/api/c_cpp_api/group__ov__layout__c__api.html).
+/// See [`ov_layout_t`](https://docs.openvino.ai/2024/api/c_cpp_api/group__ov__layout__c__api.html).
 pub struct Layout {
     ptr: *mut ov_layout_t,
 }

crates/openvino/src/lib.rs

@@ -61,7 +61,7 @@ pub use shape::Shape;
 pub use tensor::Tensor;
 pub use version::Version;
 
-/// Emit the version string of the OpenVINO C API backing this implementation.
+/// Emit the version of the OpenVINO C library backing this implementation.
 ///
 /// # Panics
 ///

crates/openvino/src/model.rs

@@ -17,7 +17,7 @@ use openvino_sys::{
 use std::borrow::Cow;
 use std::ffi::CStr;
 
-/// See [`Model`](https://docs.openvino.ai/2024/api/c_cpp_api/group__ov__model__c__api.html).
+/// See [`ov_model_t`](https://docs.openvino.ai/2024/api/c_cpp_api/group__ov__model__c__api.html).
 pub struct Model {
     ptr: *mut ov_model_t,
 }
@@ -92,7 +92,8 @@ impl Model {
     }
 }
 
-/// See [`CompiledModel`](https://docs.openvino.ai/2023.3/api/c_cpp_api/group__ov__compiled__model__c__api.html).
+/// See
+/// [`ov_compiled_model_t`](https://docs.openvino.ai/2024/api/c_cpp_api/group__ov__compiled__model__c__api.html).
 pub struct CompiledModel {
     ptr: *mut ov_compiled_model_t,
 }

crates/openvino/src/node.rs

@@ -6,7 +6,7 @@ use openvino_sys::{
 
 use std::{convert::TryInto as _, ffi::CStr};
 
-/// See [`Node`](https://docs.openvino.ai/2023.3/api/c_cpp_api/group__ov__node__c__api.html).
+/// See [`ov_node_c_api`](https://docs.openvino.ai/2024/api/c_cpp_api/group__ov__node__c__api.html).
 pub struct Node {
     ptr: *mut ov_output_const_port_t,
 }

crates/openvino/src/partial_shape.rs

@@ -7,7 +7,8 @@ use openvino_sys::{
 
 use std::convert::TryInto;
 
-/// See [`PartialShape`](https://docs.openvino.ai/2023.3/api/c_cpp_api/group__ov__partial__shape__c__api.html).
+/// See
+/// [`ov_partial_shape_t`](https://docs.openvino.ai/2024/api/c_cpp_api/group__ov__partial__shape__c__api.html).
 pub struct PartialShape {
     c_struct: ov_partial_shape_t,
 }