docs: fix naming conventions across threading, math, memory, core, and debug modules
threading/: - Rename 19 camelCase method files to hyphenated names - task-system: createtaskgroup→create-task-group, etc. - tasksystemconfig: enabletaskprofiling→enable-task-profiling, etc. - thread: getcurrentid→get-current-id, etc. - task: addref→add-ref, getid→get-id, etc. math/: - Rename underscore operator files to hyphenated - vector3: operator_add→operator-add, etc. - matrix4: gettranslation→get-translation, etc. - vector4: tovector3→to-vector3, constructor_vector3→constructor-vector3 - sphere: sphere_constructor→sphere-constructor, etc. memory/: - Remove duplicate memorymanager/ folder (kept manager/ which was correct) core/: - filewriter: Consolidate ctor-default.md and ctor-file.md into constructor.md - Rename dtor.md→destructor.md debug/: - filelogsink: Rename construct.md→constructor.md, ~filelogsink.md→destructor.md All overview pages updated with new file references.
This commit is contained in:
@@ -30,10 +30,10 @@
|
||||
| [`Shutdown`](shutdown.md) | 关闭任务系统 |
|
||||
| [`Submit(unique_ptr)`](submit.md) | 提交任务对象 |
|
||||
| [`Submit(callback)`](submit.md) | 提交 lambda 任务 |
|
||||
| [`CreateTaskGroup`](createtaskgroup.md) | 创建任务组 |
|
||||
| [`DestroyTaskGroup`](destroytaskgroup.md) | 销毁任务组 |
|
||||
| [`CreateTaskGroup`](create-task-group.md) | 创建任务组 |
|
||||
| [`DestroyTaskGroup`](destroy-task-group.md) | 销毁任务组 |
|
||||
| [`Wait`](wait.md) | 等待指定任务完成(当前为空实现) |
|
||||
| [`GetWorkerThreadCount`](getworkerthreadcount.md) | 获取工作线程数量 |
|
||||
| [`GetWorkerThreadCount`](get-worker-thread-count.md) | 获取工作线程数量 |
|
||||
| [`ParallelFor`](parallelfor.md) | 并行执行 for 循环 |
|
||||
| [`RunOnMainThread`](runonmainthread.md) | 将任务提交到主线程执行 |
|
||||
| [`Update`](update.md) | 在主线程中处理主线程队列 |
|
||||
|
||||
@@ -43,15 +43,15 @@
|
||||
|------|------|
|
||||
| `virtual ~ITask()` | 虚析构函数 |
|
||||
| [`Execute`](execute.md) | 任务执行逻辑(纯虚) |
|
||||
| [`OnComplete`](oncomplete.md) | 任务完成回调(可重写) |
|
||||
| [`OnCancel`](oncancel.md) | 任务取消回调(可重写) |
|
||||
| [`GetPriority`](getpriority.md) | 获取优先级 |
|
||||
| [`GetStatus`](getstatus.md) | 获取状态 |
|
||||
| [`GetId`](getid.md) | 获取任务 ID |
|
||||
| [`SetId`](setid.md) | 设置任务 ID |
|
||||
| [`SetPriority`](setpriority.md) | 设置优先级 |
|
||||
| [`SetStatus`](setstatus.md) | 设置状态 |
|
||||
| [`AddRef`](addref.md) | 增加引用计数 |
|
||||
| [`OnComplete`](on-complete.md) | 任务完成回调(可重写) |
|
||||
| [`OnCancel`](on-cancel.md) | 任务取消回调(可重写) |
|
||||
| [`GetPriority`](get-priority.md) | 获取优先级 |
|
||||
| [`GetStatus`](get-status.md) | 获取状态 |
|
||||
| [`GetId`](get-id.md) | 获取任务 ID |
|
||||
| [`SetId`](set-id.md) | 设置任务 ID |
|
||||
| [`SetPriority`](set-priority.md) | 设置优先级 |
|
||||
| [`SetStatus`](set-status.md) | 设置状态 |
|
||||
| [`AddRef`](add-ref.md) | 增加引用计数 |
|
||||
| [`Release`](release.md) | 减少引用计数(引用归零时自动 delete) |
|
||||
|
||||
## 受保护方法
|
||||
|
||||
@@ -12,11 +12,11 @@
|
||||
|
||||
| 成员 | 类型 | 描述 | 默认值 |
|
||||
|------|------|------|--------|
|
||||
| [`workerThreadCount`](workerthreadcount.md) | `uint32_t` | 工作线程数量(0=自动检测 CPU 核心数) | 0 |
|
||||
| [`enableTaskProfiling`](enabletaskprofiling.md) | `bool` | 启用任务性能分析(当前未使用) | true |
|
||||
| [`stealTasks`](stealtasks.md) | `bool` | 启用工作窃取(当前未实现) | true |
|
||||
| [`maxTaskQueueSize`](maxtaskqueuesize.md) | `uint32_t` | 最大任务队列大小(当前未强制限制) | 1024 |
|
||||
| [`threadStackSize`](threadstacksize.md) | `uint32_t` | 线程栈大小(当前未使用,0=系统默认) | 0 |
|
||||
| [`workerThreadCount`](worker-thread-count.md) | `uint32_t` | 工作线程数量(0=自动检测 CPU 核心数) | 0 |
|
||||
| [`enableTaskProfiling`](enable-task-profiling.md) | `bool` | 启用任务性能分析(当前未使用) | true |
|
||||
| [`stealTasks`](steal-tasks.md) | `bool` | 启用工作窃取(当前未实现) | true |
|
||||
| [`maxTaskQueueSize`](max-task-queue-size.md) | `uint32_t` | 最大任务队列大小(当前未强制限制) | 1024 |
|
||||
| [`threadStackSize`](thread-stack-size.md) | `uint32_t` | 线程栈大小(当前未使用,0=系统默认) | 0 |
|
||||
|
||||
## 使用示例
|
||||
|
||||
|
||||
@@ -29,9 +29,9 @@
|
||||
| [`Start`](start.md) | 启动线程,执行传入的函数 |
|
||||
| [`Join`](join.md) | 等待线程结束 |
|
||||
| [`Detach`](detach.md) | 分离线程,使其独立运行 |
|
||||
| [`GetId`](getid.md) | 获取线程 ID |
|
||||
| [`GetName`](getname.md) | 获取线程名称 |
|
||||
| [`GetCurrentId`](getcurrentid.md) | 获取当前线程 ID |
|
||||
| [`GetId`](get-id.md) | 获取线程 ID |
|
||||
| [`GetName`](get-name.md) | 获取线程名称 |
|
||||
| [`GetCurrentId`](get-current-id.md) | 获取当前线程 ID |
|
||||
| [`Sleep`](sleep.md) | 线程休眠指定毫秒数 |
|
||||
| [`Yield`](yield.md) | 让出当前线程的时间片 |
|
||||
|
||||
|
||||
Reference in New Issue
Block a user