thag_profiler 1.0.1

A lightweight, cross-platform Rust code profiling toolkit with zero overhead when disabled
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

# Makefile for thag_profiler documentation and common tasks

.PHONY: doc doc-internal doc-public doc-open doc-internal-open clean test lint fmt help

# Default target
help:
	@echo "Available targets:"
	@echo "  doc-public      - Build public API documentation (clean, user-facing)"
	@echo "  doc-internal    - Build internal documentation (includes implementation details and private items)"
	@echo "  doc-open        - Build and open public API documentation"
	@echo "  doc-internal-open - Build and open internal documentation (with private items)"
	@echo "  doc             - Build both public and internal documentation"
	@echo "  clean           - Clean build artifacts"
	@echo "  test            - Run tests"
	@echo "  lint            - Run clippy linter"
	@echo "  fmt             - Format code"
	@echo "  help            - Show this help message"

# Documentation targets
doc-public:
	@echo "Building public API documentation (clean, user-facing)..."
	cargo doc --package thag_profiler --features document-features,full_profiling,debug_logging --no-deps

doc-internal:
	@echo "Building internal documentation (includes implementation details and private items)..."
	cargo doc --package thag_profiler --features document-features,full_profiling,debug_logging,internal_docs --no-deps --document-private-items

doc-open:
	@echo "Building and opening public API documentation..."
	cargo doc --package thag_profiler --features document-features,full_profiling,debug_logging --no-deps --open

doc-internal-open:
	@echo "Building and opening internal documentation..."
	cargo doc --package thag_profiler --features document-features,full_profiling,debug_logging,internal_docs --no-deps --document-private-items --open

doc: doc-public doc-internal
	@echo "Both documentation modes built successfully!"

# Development targets
clean:
	cargo clean --package thag_profiler

test:
	cargo test --package thag_profiler

lint:
	cargo clippy --package thag_profiler --all-targets --all-features

fmt:
	cargo fmt --package thag_profiler

# Convenience aliases
docs: doc
doc-pub: doc-public
doc-int: doc-internal