Revise the Doxygen documentation #270

gheber · 2021-11-03T15:06:59Z

This is a catch-all placeholder for Doxygen issues. Let's convert comments to issues and assign them to the next beta round as we go.

gheber · 2021-11-04T13:34:31Z

/home/hermes/hermes/src/buffer_pool.h:72: warning: Compound hermes::Target is not documented.
/home/hermes/hermes/src/buffer_pool.h:104: warning: Compound hermes::ShmemClientInfo is not documented.
/home/hermes/hermes/src/buffer_pool.h:242: warning: Compound hermes::SharedMemoryContext is not documented.
/home/hermes/hermes/src/buffer_pool.h:400: warning: Compound hermes::SwapBlob is not documented.
/home/hermes/hermes/src/buffer_organizer.h:35: warning: Compound hermes::BoArgs is not documented.
/home/hermes/hermes/src/buffer_organizer.h:49: warning: Compound hermes::BoTask is not documented.
/home/hermes/hermes/src/buffer_organizer.h:54: warning: Compound hermes::BufferOrganizer is not documented.
/home/hermes/hermes/src/communication.h:32: warning: Compound hermes::CommunicationContext is not documented.
/home/hermes/hermes/src/data_placement_engine.h:26: warning: Compound hermes::RoundRobinState is not documented.
/home/hermes/hermes/src/debug_state.h:18: warning: Compound hermes::DebugHeapAllocation is not documented.
/home/hermes/hermes/src/debug_state.h:25: warning: Compound hermes::DebugState is not documented.
/home/hermes/hermes/src/hermes_status.h:53: warning: Compound hermes::api::Status is not documented.
/home/hermes/hermes/src/hermes_types.h:201: warning: Compound hermes::BucketID is not documented.
/home/hermes/hermes/src/hermes_types.h:53: warning: Compound hermes::api::Context is not documented.
/home/hermes/hermes/src/hermes_types.h:216: warning: Compound hermes::VBucketID is not documented.
/home/hermes/hermes/src/hermes_types.h:225: warning: Compound hermes::BlobID is not documented.
/home/hermes/hermes/src/hermes_types.h:248: warning: Compound hermes::TraitIdArray is not documented.
/home/hermes/hermes/src/memory_management.h:41: warning: Compound hermes::Ticket is not documented.
/home/hermes/hermes/src/memory_management.h:46: warning: Compound hermes::ArenaInfo is not documented.
/home/hermes/hermes/src/memory_management.h:81: warning: Compound hermes::Heap is not documented.
/home/hermes/hermes/src/memory_management.h:93: warning: Compound hermes::FreeBlockHeader is not documented.
/home/hermes/hermes/src/memory_management.h:97: warning: Compound hermes::FreeBlock is not documented.
/home/hermes/hermes/src/memory_management.h:104: warning: Compound hermes::TemporaryMemory is not documented.
/home/hermes/hermes/src/metadata_management.h:39: warning: Compound hermes::Stats is not documented.
/home/hermes/hermes/src/metadata_management.h:46: warning: Compound hermes::ChunkedIdList is not documented
/home/hermes/hermes/src/metadata_management.h:52: warning: Compound hermes::IdList is not documented.
/home/hermes/hermes/src/metadata_management.h:57: warning: Compound hermes::BufferIdArray is not documented.
/home/hermes/hermes/src/metadata_management.h:62: warning: Compound hermes::BlobInfo is not documented.
/home/hermes/hermes/src/metadata_management.h:82: warning: Compound hermes::BucketInfo is not documented.
/home/hermes/hermes/src/metadata_management.h:91: warning: Compound hermes::VBucketInfo is not documented.
/home/hermes/hermes/src/metadata_management.h:100: warning: Compound hermes::SystemViewState is not documented.
/home/hermes/hermes/src/metadata_management.h:105: warning: Compound hermes::MetadataManager is not documented.
/home/hermes/hermes/src/rpc.h:32: warning: Compound hermes::ClientRpcContext is not documented.
/home/hermes/hermes/src/rpc.h:37: warning: Compound hermes::RpcContext is not documented.
/home/hermes/hermes/src/rpc_thallium.h:37: warning: Compound hermes::ThalliumState is not documented.
/home/hermes/hermes/src/rpc_thallium.h:47: warning: Compound hermes::ClientThalliumState is not documented.
/home/hermes/hermes/src/stb_ds.h:656: warning: Compound stbds_array_header is not documented.
/home/hermes/hermes/src/stb_ds.h:664: warning: Compound stbds_string_block is not documented.
/home/hermes/hermes/src/stb_ds.h:670: warning: Compound stbds_string_arena is not documented.
/home/hermes/hermes/src/thread_pool.h:23: warning: Compound hermes::ThreadPool is not documented.
/home/hermes/hermes/src/utils.h:109: warning: Compound hermes::testing::TargetViewState is not documented.

gheber · 2021-11-04T13:35:57Z

/home/hermes/hermes/src/buffer_pool.h:73: warning: Member id (variable) of class hermes::Target is not documented.
/home/hermes/hermes/src/buffer_pool.h:76: warning: Member remaining_space (variable) of class hermes::Target is not documented.
/home/hermes/hermes/src/buffer_pool.h:77: warning: Member speed (variable) of class hermes::Target is not documented.
/home/hermes/hermes/src/buffer_pool.h:98: warning: Member bits (variable) of class hermes::BufferID is not documented.
/home/hermes/hermes/src/buffer_pool.h:105: warning: Member mdm_offset (variable) of class hermes::ShmemClientInfo is not documented.
/home/hermes/hermes/src/buffer_pool.h:106: warning: Member bpm_offset (variable) of class hermes::ShmemClientInfo is not documented.
/home/hermes/hermes/src/buffer_pool.h:175: warning: Member targets_offset (variable) of class hermes::BufferPool is not documented.
/home/hermes/hermes/src/buffer_pool.h:200: warning: Found unknown command '\optimization'
/home/hermes/hermes/src/buffer_pool.h:204: warning: Member capacity_adjustments[kMaxDevices] (variable) of class hermes::BufferPool is not documented.
/home/hermes/hermes/src/buffer_pool.h:214: warning: Member num_targets (variable) of class hermes::BufferPool is not documented.
/home/hermes/hermes/src/buffer_pool.h:255: warning: Member buffering_filenames (variable) of class hermes::SharedMemoryContext is not documented.
/home/hermes/hermes/src/buffer_pool.h:256: warning: Member open_files[kMaxDevices][kMaxBufferPoolSlabs] (variable) of class hermes::SharedMemoryContext is not documented.
/home/hermes/hermes/src/buffer_pool.h:257: warning: Member swap_file (variable) of class hermes::SharedMemoryContext is not documented.
/home/hermes/hermes/src/buffer_pool.h:286: warning: argument 'make_space' of command @param is not found in the argument list of hermes::InitFilesForBuffering(SharedMemoryContext *context, CommunicationContext &comm)
/home/hermes/hermes/src/buffer_pool.h:286: warning: argument 'node_id' of command @param is not found in the argument list of hermes::InitFilesForBuffering(SharedMemoryContext *context, CommunicationContext &comm)
/home/hermes/hermes/src/buffer_pool.h:286: warning: argument 'first_on_node' of command @param is not found in the argument list of hermes::InitFilesForBuffering(SharedMemoryContext *context, CommunicationContext &comm)
/home/hermes/hermes/src/buffer_pool.h:401: warning: Member node_id (variable) of class hermes::SwapBlob is not documented.
/home/hermes/hermes/src/buffer_pool.h:402: warning: Member offset (variable) of class hermes::SwapBlob is not documented.
/home/hermes/hermes/src/buffer_pool.h:403: warning: Member size (variable) of class hermes::SwapBlob is not documented.
/home/hermes/hermes/src/buffer_pool.h:404: warning: Member bucket_id (variable) of class hermes::SwapBlob is not documented.
/home/hermes/hermes/src/buffer_pool.h:408: warning: Member SwapBlobMembers (enumeration) of namespace hermes is not documented.
/home/hermes/hermes/src/buffer_pool.h:468: warning: Member PutToSwap(SharedMemoryContext *context, RpcContext *rpc, BucketID id, std::vector< std::vector< T >> &blobs, std::vector< std::string > &names) (function) of namespace hermes is not documented.
/home/hermes/hermes/src/buffer_pool.h:485: warning: Member WriteToSwap(SharedMemoryContext *context, Blob blob, BlobID blob_id, BucketID bucket_id) (function) of namespace hermes is not documented.

gheber · 2021-11-04T13:42:26Z

/home/hermes/hermes/src/communication.h:29: warning: Member BarrierFunc)(void *) (typedef) of namespace hermes is not documented.
/home/hermes/hermes/src/communication.h:30: warning: Member FinalizeFunc)(void *) (typedef) of namespace hermes is not documented.
/home/hermes/hermes/src/communication.h:67: warning: Member WorldBarrier(CommunicationContext *comm) (function) of namespace hermes is not documented.
/home/hermes/hermes/src/communication.h:71: warning: Member SubBarrier(CommunicationContext *comm) (function) of namespace hermes is not documented.

gheber · 2021-11-04T13:43:20Z

/home/hermes/hermes/src/memory_management.h:30: warning: Member ArenaErrorFunc() (typedef) of namespace hermes is not documented.
/home/hermes/hermes/src/memory_management.h:37: warning: Member ticket (variable) of class hermes::TicketMutex is not documented.
/home/hermes/hermes/src/memory_management.h:38: warning: Member serving (variable) of class hermes::TicketMutex is not documented.
/home/hermes/hermes/src/memory_management.h:42: warning: Member ticket (variable) of class hermes::Ticket is not documented.
/home/hermes/hermes/src/memory_management.h:43: warning: Member acquired (variable) of class hermes::Ticket is not documented.
/home/hermes/hermes/src/memory_management.h:47: warning: Member sizes[kArenaType_Count] (variable) of class hermes::ArenaInfo is not documented.
/home/hermes/hermes/src/memory_management.h:48: warning: Member total (variable) of class hermes::ArenaInfo is not documented.
/home/hermes/hermes/src/memory_management.h:99: warning: Member next_offset (variable) of class hermes::FreeBlock is not documented.
/home/hermes/hermes/src/memory_management.h:101: warning: Member size (variable) of class hermes::FreeBlock is not documented.
/home/hermes/hermes/src/memory_management.h:94: warning: Member size (variable) of class hermes::FreeBlockHeader is not documented.
/home/hermes/hermes/src/memory_management.h:82: warning: Member error_handler (variable) of class hermes::Heap is not documented.
/home/hermes/hermes/src/memory_management.h:83: warning: Member mutex (variable) of class hermes::Heap is not documented.
/home/hermes/hermes/src/memory_management.h:88: warning: Member extent (variable) of class hermes::Heap is not documented.
/home/hermes/hermes/src/memory_management.h:89: warning: Member alignment (variable) of class hermes::Heap is not documented.
/home/hermes/hermes/src/memory_management.h:90: warning: Member grows_up (variable) of class hermes::Heap is not documented.
/home/hermes/hermes/src/memory_management.h:350: warning: Member HeapPushArray(Heap *heap, u32 count) (function) of namespace hermes is not documented.

gheber · 2021-11-04T13:43:51Z

/home/hermes/hermes/src/utils.h:48: warning: Member HERMES_BEGIN_TIMED_BLOCK(func_name) (macro definition) of file utils.h is not documented.
/home/hermes/hermes/src/utils.h:49: warning: Member HERMES_END_TIMED_BLOCK() (macro definition) of file utils.h is not documented.
/home/hermes/hermes/src/utils.h:101: warning: Member BlobSizeRange (enumeration) of namespace hermes::testing is not documented.
/home/hermes/hermes/src/utils.h:110: warning: Member bytes_capacity (variable) of class hermes::testing::TargetViewState is not documented.
/home/hermes/hermes/src/utils.h:111: warning: Member bytes_available (variable) of class hermes::testing::TargetViewState is not documented.
/home/hermes/hermes/src/utils.h:112: warning: Member bandwidth (variable) of class hermes::testing::TargetViewState is not documented.
/home/hermes/hermes/src/utils.h:113: warning: Member ordered_cap (variable) of class hermes::testing::TargetViewState is not documented.
/home/hermes/hermes/src/utils.h:114: warning: Member num_devices (variable) of class hermes::testing::TargetViewState is not documented.
/home/hermes/hermes/src/utils.h:141: warning: argument 'The' of command @param is not found in the argument list of hermes::testing::PrintNodeState(TargetViewState &node_state)

gheber · 2021-11-04T13:44:22Z

/home/hermes/hermes/src/stb_ds.h:657: warning: Member length (variable) of class stbds_array_header is not documented.
/home/hermes/hermes/src/stb_ds.h:658: warning: Member capacity (variable) of class stbds_array_header is not documented.
/home/hermes/hermes/src/stb_ds.h:659: warning: Member hash_table_offset (variable) of class stbds_array_header is not documented.
/home/hermes/hermes/src/stb_ds.h:660: warning: Member temp (variable) of class stbds_array_header is not documented.
/home/hermes/hermes/src/stb_ds.h:671: warning: Member storage (variable) of class stbds_string_arena is not documented.
/home/hermes/hermes/src/stb_ds.h:672: warning: Member remaining (variable) of class stbds_string_arena is not documented.
/home/hermes/hermes/src/stb_ds.h:673: warning: Member block (variable) of class stbds_string_arena is not documented.
/home/hermes/hermes/src/stb_ds.h:674: warning: Member mode (variable) of class stbds_string_arena is not documented.
/home/hermes/hermes/src/stb_ds.h:665: warning: Member next (variable) of class stbds_string_block is not documented.
/home/hermes/hermes/src/stb_ds.h:666: warning: Member storage[8] (variable) of class stbds_string_block is not documented.

gheber · 2021-11-04T13:44:54Z

/home/hermes/hermes/src/metadata_management.h:40: warning: Member recency (variable) of class hermes::Stats is not documented.
/home/hermes/hermes/src/metadata_management.h:41: warning: Member frequency (variable) of class hermes::Stats is not documented.
/home/hermes/hermes/src/metadata_management.h:47: warning: Member head_offset (variable) of class hermes::ChunkedIdList is not documented.
/home/hermes/hermes/src/metadata_management.h:48: warning: Member length (variable) of class hermes::ChunkedIdList is not documented.
/home/hermes/hermes/src/metadata_management.h:49: warning: Member capacity (variable) of class hermes::ChunkedIdList is not documented.
/home/hermes/hermes/src/metadata_management.h:53: warning: Member head_offset (variable) of class hermes::IdList is not documented.
/home/hermes/hermes/src/metadata_management.h:54: warning: Member length (variable) of class hermes::IdList is not documented.
/home/hermes/hermes/src/metadata_management.h:58: warning: Member ids (variable) of class hermes::BufferIdArray is not documented.
/home/hermes/hermes/src/metadata_management.h:59: warning: Member length (variable) of class hermes::BufferIdArray is not documented.
/home/hermes/hermes/src/metadata_management.h:63: warning: Member stats (variable) of class hermes::BlobInfo is not documented.
/home/hermes/hermes/src/metadata_management.h:64: warning: Member lock (variable) of class hermes::BlobInfo is not documented.
/home/hermes/hermes/src/metadata_management.h:73: warning: Member operator=(const BlobInfo &other) (function) of class hermes::BlobInfo is not documented.
/home/hermes/hermes/src/metadata_management.h:83: warning: Member next_free (variable) of class hermes::BucketInfo is not documented.
/home/hermes/hermes/src/metadata_management.h:84: warning: Member blobs (variable) of class hermes::BucketInfo is not documented.
/home/hermes/hermes/src/metadata_management.h:85: warning: Member ref_count (variable) of class hermes::BucketInfo is not documented.
/home/hermes/hermes/src/metadata_management.h:86: warning: Member active (variable) of class hermes::BucketInfo is not documented.
/home/hermes/hermes/src/metadata_management.h:92: warning: Member next_free (variable) of class hermes::VBucketInfo is not documented.
/home/hermes/hermes/src/metadata_management.h:93: warning: Member blobs (variable) of class hermes::VBucketInfo is not documented.
/home/hermes/hermes/src/metadata_management.h:94: warning: Member ref_count (variable) of class hermes::VBucketInfo is not documented.
/home/hermes/hermes/src/metadata_management.h:95: warning: Member async_flush_count (variable) of class hermes::VBucketInfo is not documented.
/home/hermes/hermes/src/metadata_management.h:96: warning: Member traits[kMaxTraitsPerVBucket] (variable) of class hermes::VBucketInfo is not documented.
/home/hermes/hermes/src/metadata_management.h:97: warning: Member active (variable) of class hermes::VBucketInfo is not documented.
/home/hermes/hermes/src/metadata_management.h:101: warning: Member bytes_available[kMaxDevices] (variable) of class hermes::SystemViewState is not documented.
/home/hermes/hermes/src/metadata_management.h:102: warning: Member num_devices (variable) of class hermes::SystemViewState is not documented.
/home/hermes/hermes/src/memory_management.h:105: warning: Member arena (variable) of class hermes::TemporaryMemory is not documented.
/home/hermes/hermes/src/memory_management.h:106: warning: Member used (variable) of class hermes::TemporaryMemory is not documented.
/home/hermes/hermes/src/metadata_management.h:107: warning: Member bucket_info_offset (variable) of class hermes::MetadataManager is not documented.
/home/hermes/hermes/src/metadata_management.h:108: warning: Member first_free_bucket (variable) of class hermes::MetadataManager is not documented.
/home/hermes/hermes/src/metadata_management.h:110: warning: Member vbucket_info_offset (variable) of class hermes::MetadataManager is not documented.
/home/hermes/hermes/src/metadata_management.h:111: warning: Member first_free_vbucket (variable) of class hermes::MetadataManager is not documented.
/home/hermes/hermes/src/metadata_management.h:113: warning: Member rpc_state_offset (variable) of class hermes::MetadataManager is not documented.
/home/hermes/hermes/src/metadata_management.h:114: warning: Member system_view_state_offset (variable) of class hermes::MetadataManager is not documented.
/home/hermes/hermes/src/metadata_management.h:115: warning: Member global_system_view_state_offset (variable) of class hermes::MetadataManager is not documented.
/home/hermes/hermes/src/metadata_management.h:117: warning: Member id_heap_offset (variable) of class hermes::MetadataManager is not documented.
/home/hermes/hermes/src/metadata_management.h:118: warning: Member map_heap_offset (variable) of class hermes::MetadataManager is not documented.
/home/hermes/hermes/src/metadata_management.h:120: warning: Member bucket_map_offset (variable) of class hermes::MetadataManager is not documented.
/home/hermes/hermes/src/metadata_management.h:121: warning: Member vbucket_map_offset (variable) of class hermes::MetadataManager is not documented.
/home/hermes/hermes/src/metadata_management.h:122: warning: Member blob_id_map_offset (variable) of class hermes::MetadataManager is not documented.
/home/hermes/hermes/src/metadata_management.h:123: warning: Member blob_info_map_offset (variable) of class hermes::MetadataManager is not documented.
/home/hermes/hermes/src/metadata_management.h:125: warning: Member swap_filename_prefix_offset (variable) of class hermes::MetadataManager is not documented.
/home/hermes/hermes/src/metadata_management.h:126: warning: Member swap_filename_suffix_offset (variable) of class hermes::MetadataManager is not documented.
/home/hermes/hermes/src/metadata_management.h:149: warning: Member map_seed (variable) of class hermes::MetadataManager is not documented.
/home/hermes/hermes/src/metadata_management.h:151: warning: Member node_targets (variable) of class hermes::MetadataManager is not documented.
/home/hermes/hermes/src/metadata_management.h:152: warning: Member neighborhood_targets (variable) of class hermes::MetadataManager is not documented.
/home/hermes/hermes/src/metadata_management.h:154: warning: Member system_view_state_update_interval_ms (variable) of class hermes::MetadataManager is not documented.
/home/hermes/hermes/src/metadata_management.h:155: warning: Member global_system_view_state_node_id (variable) of class hermes::MetadataManager is not documented.
/home/hermes/hermes/src/metadata_management.h:156: warning: Member num_buckets (variable) of class hermes::MetadataManager is not documented.
/home/hermes/hermes/src/metadata_management.h:157: warning: Member max_buckets (variable) of class hermes::MetadataManager is not documented.
/home/hermes/hermes/src/metadata_management.h:158: warning: Member num_vbuckets (variable) of class hermes::MetadataManager is not documented.
/home/hermes/hermes/src/metadata_management.h:159: warning: Member max_vbuckets (variable) of class hermes::MetadataManager is not documented.
/home/hermes/hermes/src/metadata_management.h:160: warning: Member clock (variable) of class hermes::MetadataManager is not documented.

gheber · 2021-11-04T13:45:45Z

/home/hermes/hermes/src/buffer_organizer.h:39: warning: Member move_args (variable) of class hermes::BoArgs is not documented.
/home/hermes/hermes/src/buffer_organizer.h:43: warning: Member copy_args (variable) of class hermes::BoArgs is not documented.
/home/hermes/hermes/src/buffer_organizer.h:46: warning: Member delete_args (variable) of class hermes::BoArgs is not documented.
/home/hermes/hermes/src/buffer_organizer.h:50: warning: Member op (variable) of class hermes::BoTask is not documented.
/home/hermes/hermes/src/buffer_organizer.h:51: warning: Member args (variable) of class hermes::BoTask is not documented.
/home/hermes/hermes/src/buffer_organizer.h:55: warning: Member pool (variable) of class hermes::BufferOrganizer is not documented.
/home/hermes/hermes/src/buffer_organizer.h:57: warning: Member BufferOrganizer(int num_threads) (function) of class hermes::BufferOrganizer is not documented.

gheber · 2021-11-04T13:55:24Z

/home/hermes/hermes/src/rpc.h:33: warning: Member state (variable) of class hermes::ClientRpcContext is not documented.
/home/hermes/hermes/src/rpc.h:34: warning: Member state_size (variable) of class hermes::ClientRpcContext is not documented.
/home/hermes/hermes/src/rpc.h:38: warning: Member client_rpc (variable) of class hermes::RpcContext is not documented.
/home/hermes/hermes/src/rpc.h:39: warning: Member state (variable) of class hermes::RpcContext is not documented.
/home/hermes/hermes/src/rpc.h:42: warning: Member node_id (variable) of class hermes::RpcContext is not documented.
/home/hermes/hermes/src/rpc.h:43: warning: Member num_nodes (variable) of class hermes::RpcContext is not documented.
/home/hermes/hermes/src/rpc.h:44: warning: Member port (variable) of class hermes::RpcContext is not documented.
/home/hermes/hermes/src/rpc.h:55: warning: Member hostname_suffix[kMaxServerSuffixSize] (variable) of class hermes::RpcContext is not documented.
/home/hermes/hermes/src/rpc.h:62: warning: Member start_server (variable) of class hermes::RpcContext is not documented.

gheber · 2021-11-04T13:55:43Z

/home/hermes/hermes/src/rpc_thallium.h:38: warning: Member server_name_prefix[kMaxServerNamePrefix] (variable) of class hermes::ThalliumState is not documented.
/home/hermes/hermes/src/rpc_thallium.h:39: warning: Member server_name_postfix[kMaxServerNamePostfix] (variable) of class hermes::ThalliumState is not documented.
/home/hermes/hermes/src/rpc_thallium.h:40: warning: Member bo_server_name_postfix[kMaxServerNamePostfix] (variable) of class hermes::ThalliumState is not documented.
/home/hermes/hermes/src/rpc_thallium.h:41: warning: Member kill_requested (variable) of class hermes::ThalliumState is not documented.
/home/hermes/hermes/src/rpc_thallium.h:42: warning: Member engine (variable) of class hermes::ThalliumState is not documented.
/home/hermes/hermes/src/rpc_thallium.h:43: warning: Member bo_engine (variable) of class hermes::ThalliumState is not documented.
/home/hermes/hermes/src/rpc_thallium.h:44: warning: Member execution_stream (variable) of class hermes::ThalliumState is not documented.
/home/hermes/hermes/src/rpc_thallium.h:48: warning: Member engine (variable) of class hermes::ClientThalliumState is not documented.

gheber · 2021-11-04T13:56:08Z

/home/hermes/hermes/src/communication.h:33: warning: Member world_barrier (variable) of class hermes::CommunicationContext is not documented.
/home/hermes/hermes/src/communication.h:34: warning: Member sub_barrier (variable) of class hermes::CommunicationContext is not documented.
/home/hermes/hermes/src/communication.h:35: warning: Member finalize (variable) of class hermes::CommunicationContext is not documented.

gheber · 2021-11-04T13:57:31Z

/home/hermes/hermes/src/debug_state.h:19: warning: Member offset (variable) of class hermes::DebugHeapAllocation is not documented.
/home/hermes/hermes/src/debug_state.h:20: warning: Member size (variable) of class hermes::DebugHeapAllocation is not documented.
Generating docs for compound hermes::DebugState...
/home/hermes/hermes/src/debug_state.h:26: warning: Member shmem_base (variable) of class hermes::DebugState is not documented.
/home/hermes/hermes/src/debug_state.h:27: warning: Member allocations[kGlobalDebugMaxAllocations] (variable) of class hermes::DebugState is not documented.
/home/hermes/hermes/src/debug_state.h:28: warning: Member mutex (variable) of class hermes::DebugState is not documented.
/home/hermes/hermes/src/debug_state.h:29: warning: Member allocation_count (variable) of class hermes::DebugState is not documented.

gheber · 2021-11-04T14:22:55Z

/home/hermes/hermes/src/thread_pool.h:25: warning: Member ThreadPool(unsigned num_threads=std::thread::hardware_concurrency()) (function) of class hermes::ThreadPool is not documented.
/home/hermes/hermes/src/thread_pool.h:58: warning: Member run(F &&f, bool high_priority=false) const (function) of class hermes::ThreadPool is not documented.
/home/hermes/hermes/src/thread_pool.h:90: warning: Member threads (variable) of class hermes::ThreadPool is not documented.
/home/hermes/hermes/src/thread_pool.h:91: warning: Member queue_low (variable) of class hermes::ThreadPool is not documented.
/home/hermes/hermes/src/thread_pool.h:92: warning: Member queue_high (variable) of class hermes::ThreadPool is not documented.
/home/hermes/hermes/src/thread_pool.h:93: warning: Member mutex (variable) of class hermes::ThreadPool is not documented.
/home/hermes/hermes/src/thread_pool.h:94: warning: Member condvar (variable) of class hermes::ThreadPool is not documented.

gheber · 2021-11-08T16:44:07Z

First things first: Focus on the Hermes API! #189

…up#270)

…p#270)

…up#270, HDFGroup#465)

…FGroup#465)

…ser.h. (HDFGroup#270)

…#270)

Remove Doxygen warnings. (#270)

gheber created this issue from a note in 0.1.0-beta (To Do) Nov 3, 2021

gheber self-assigned this Nov 3, 2021

gheber added documentation Improvements or additions to documentation effort-medium Can be completed in a week or less labels Nov 3, 2021

gheber moved this from To Do to In progress in 0.1.0-beta Nov 4, 2021

This comment has been minimized.

Sign in to view

This was referenced Nov 4, 2021

Spruce up the hermes_types.h documentation. #275

Closed

Spruce up the data_placement_engine.h documentation #276

Closed

Spruce up the hermes_status.h documentation. #277

Closed

gheber removed this from In progress in 0.1.0-beta Nov 4, 2021

gheber added this to To do in 0.2.0-beta Nov 8, 2021

gheber closed this as completed Nov 8, 2021

gheber reopened this Nov 8, 2021

ChristopherHogan added this to To do in 0.3.0-beta Dec 17, 2021

hyoklee added a commit to hyoklee/hermes that referenced this issue Oct 24, 2022

Remove Doxygen warnings for src/api/vbucket.h. (HDFGroup#270)

42aa400

hyoklee added a commit to hyoklee/hermes that referenced this issue Oct 31, 2022

Remove Doxygen warnings for adapter/mapper/abstract_mapper.h. (HDFGro…

4bf444c

…up#270)

hyoklee added a commit to hyoklee/hermes that referenced this issue Nov 1, 2022

Remove Doxygen warnings for adapter/filesystem/filesystem.h. (HDFGrou…

c6a72a1

…p#270)

hyoklee added a commit to hyoklee/hermes that referenced this issue Nov 1, 2022

Remove Doxygen warnings for adapter/mpiio/real_api.h. (HDFGroup#270)

37a5b6b

hyoklee added a commit to hyoklee/hermes that referenced this issue Nov 1, 2022

Remove Doxygen warnings for adapter/posix/real_api.h. (HDFGroup#270)

7fd8425

hyoklee added a commit to hyoklee/hermes that referenced this issue Nov 1, 2022

Remove Doxygen warnings for adapter/stdio/real_api.h. (HDFGroup#270)

026b622

hyoklee added a commit to hyoklee/hermes that referenced this issue Nov 1, 2022

Remove Doxygen warnings for adapter/mpiio/fs_api.h. (HDFGroup#270)

e535dfb

hyoklee added a commit to hyoklee/hermes that referenced this issue Nov 1, 2022

Remove Doxygen warnings for adapter/stdio/fs_api.h. (HDFGroup#270)

01c8c8a

hyoklee added a commit to hyoklee/hermes that referenced this issue Nov 1, 2022

Remove Doxygen warnings for adapter/posix/fs_api.h. (HDFGroup#270)

0ce35c7

hyoklee added a commit to hyoklee/hermes that referenced this issue Nov 1, 2022

Remove Doxygen warnings for adapter/filesystem/filesystem.cc. (HDFGro…

57695fc

…up#270, HDFGroup#465)

hyoklee added a commit to hyoklee/hermes that referenced this issue Nov 1, 2022

Remove Doxygen warnings for src/buffer_organizer.h. (HDFGroup#270, HD…

2af28c2

…FGroup#465)

hyoklee added a commit to hyoklee/hermes that referenced this issue Nov 1, 2022

Remove Doxygen warnings for src/buffer_organizer.cc. (HDFGroup#270)

6809973

hyoklee added a commit to hyoklee/hermes that referenced this issue Nov 1, 2022

Remove Doxygen warnings for src/rpc.h. (HDFGroup#270)

3f22c8c

hyoklee added a commit to hyoklee/hermes that referenced this issue Nov 1, 2022

Remove Doxygen warnings for src/data_placement_engine.cc. (HDFGroup#270)

2129830

hyoklee added a commit to hyoklee/hermes that referenced this issue Nov 1, 2022

Remove Doxygen warnings for src/metadata_management.h. (HDFGroup#270)

4f427e6

hyoklee added a commit to hyoklee/hermes that referenced this issue Nov 1, 2022

Remove Doxygen warnings for src/api/hermes.cc. (HDFGroup#270)

481333d

hyoklee added a commit to hyoklee/hermes that referenced this issue Nov 1, 2022

Remove Doxygen warnings for src/config_parser.cc. (HDFGroup#270)

4f02419

hyoklee added a commit to hyoklee/hermes that referenced this issue Nov 1, 2022

Remove Doxygen warnings for src/config_parser.h. (HDFGroup#270)

92f325d

hyoklee added a commit to hyoklee/hermes that referenced this issue Nov 1, 2022

Remove Doxygen warnings for src/metadata_management.cc src/config_par…

455e045

…ser.h. (HDFGroup#270)

hyoklee added a commit to hyoklee/hermes that referenced this issue Nov 1, 2022

Remove Doxygen warnings for src/metadata_storage_stb_ds.cc. (HDFGroup…

dac061c

…#270)

hyoklee added a commit to hyoklee/hermes that referenced this issue Nov 1, 2022

Remove Doxygen warnings for src/rpc_thallium.cc. (HDFGroup#270)

ac3791d

hyoklee added a commit to hyoklee/hermes that referenced this issue Nov 1, 2022

Remove Doxygen warnings for src/rpc_thallium.h. (HDFGroup#270)

f6ffd8b

hyoklee added a commit to hyoklee/hermes that referenced this issue Nov 1, 2022

Remove Doxygen warnings for src/debug_state.h. (HDFGroup#270)

6216dde

hyoklee added a commit to hyoklee/hermes that referenced this issue Nov 1, 2022

Remove Doxygen warnings. (HDFGroup#270)

b56f9ec

hyoklee added a commit to hyoklee/hermes that referenced this issue Nov 1, 2022

Remove Doxygen warnings. (HDFGroup#270)

d484e61

hyoklee added a commit to hyoklee/hermes that referenced this issue Nov 2, 2022

Remove Doxygen 1.8.17 error. (HDFGroup#270)

6087dbe

hyoklee added a commit that referenced this issue Nov 2, 2022

Remove Doxygen warnings. (#270)

daf0359

lukemartinlogan added a commit that referenced this issue Nov 3, 2022

Merge pull request #467 from HDFGroup/issue-270

3124cca

Remove Doxygen warnings. (#270)

hyoklee moved this from In progress to Done in 0.9.0-beta Nov 3, 2022

hyoklee closed this as completed Nov 3, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Revise the Doxygen documentation #270

Revise the Doxygen documentation #270

gheber commented Nov 3, 2021 •

edited

Loading

gheber commented Nov 4, 2021 •

edited

Loading

gheber commented Nov 4, 2021 •

edited

Loading

gheber commented Nov 4, 2021

gheber commented Nov 4, 2021 •

edited

Loading

gheber commented Nov 4, 2021 •

edited

Loading

gheber commented Nov 4, 2021 •

edited

Loading

gheber commented Nov 4, 2021 •

edited

Loading

gheber commented Nov 4, 2021 •

edited

Loading

This comment has been minimized.

gheber commented Nov 4, 2021 •

edited

Loading

gheber commented Nov 4, 2021 •

edited

Loading

gheber commented Nov 4, 2021

gheber commented Nov 4, 2021

This comment has been minimized.

gheber commented Nov 4, 2021

This comment has been minimized.

gheber commented Nov 8, 2021 •

edited

Loading

Revise the Doxygen documentation #270

Revise the Doxygen documentation #270

Comments

gheber commented Nov 3, 2021 • edited Loading

gheber commented Nov 4, 2021 • edited Loading

gheber commented Nov 4, 2021 • edited Loading

gheber commented Nov 4, 2021

gheber commented Nov 4, 2021 • edited Loading

gheber commented Nov 4, 2021 • edited Loading

gheber commented Nov 4, 2021 • edited Loading

gheber commented Nov 4, 2021 • edited Loading

gheber commented Nov 4, 2021 • edited Loading

This comment has been minimized.

gheber commented Nov 4, 2021 • edited Loading

gheber commented Nov 4, 2021 • edited Loading

gheber commented Nov 4, 2021

gheber commented Nov 4, 2021

This comment has been minimized.

gheber commented Nov 4, 2021

This comment has been minimized.

gheber commented Nov 8, 2021 • edited Loading

gheber commented Nov 3, 2021 •

edited

Loading

gheber commented Nov 4, 2021 •

edited

Loading

gheber commented Nov 4, 2021 •

edited

Loading

gheber commented Nov 4, 2021 •

edited

Loading

gheber commented Nov 4, 2021 •

edited

Loading

gheber commented Nov 4, 2021 •

edited

Loading

gheber commented Nov 4, 2021 •

edited

Loading

gheber commented Nov 4, 2021 •

edited

Loading

gheber commented Nov 4, 2021 •

edited

Loading

gheber commented Nov 4, 2021 •

edited

Loading

gheber commented Nov 8, 2021 •

edited

Loading