Skip to content

Use feature instead of exporting the crate for testing with hidden doc #476

Open
@xieyuschen

Description

@xieyuschen

Currently, iceoryx exposes an API for testing purpose and hides its docs. I think a more reasonable approach is define a feature called iox2-test for it so we can ensure it won't be involved inside users code except the explicit feature setting up. A testing feature is needed because the default test doesn't support cross package usage.

/// Simple BumpAllocator for testing purposes. Do not use this in production. If you are looking
/// for a production ready BumpAllocator use the one from iceoryx2_bb_memory::bump_allocator
#[doc(hidden)]
pub struct BumpAllocator {

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions