Skip to content

docs(lanelet2_utils): simplify API table title for utils #851

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sasakisasaki merged 6 commits into from
Mar 6, 2026
Merged

docs(lanelet2_utils): simplify API table title for utils #851

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
65002d8
change API table title to filename instead of raw path
sarun-hub Feb 19, 2026
f135008
fix typo
sarun-hub Feb 20, 2026
3cff85b
Merge branch 'main' into docs/clean_lanelet2_utils_api_title
sarun-hub Feb 20, 2026
6dc1755
Merge branch 'main' into docs/clean_lanelet2_utils_api_title
sarun-hub Feb 25, 2026
d156fdf
Merge branch 'main' into docs/clean_lanelet2_utils_api_title
sarun-hub Feb 25, 2026
08199c8
Merge branch 'main' into docs/clean_lanelet2_utils_api_title
sarun-hub Mar 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions common/autoware_lanelet2_utils/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ This package aims to strictly define the meaning of several words to clarify the

## API description

### `<autoware/lanelet2_utils/geometry.hpp>`
### `geometry`

| Function | Description | Average Computational Complexity | Illustration |
| --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
Expand Down Expand Up @@ -239,7 +239,7 @@ common/autoware_lanelet2_utils/examples/example_geometry.cpp:574:580
--8<--
```

### `<autoware/lanelet2_utils/conversion.hpp>`
### `conversion`

| Function | Description | Average Computational Complexity | Illustration |
| ----------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | ------------ |
Expand Down Expand Up @@ -316,7 +316,7 @@ common/autoware_lanelet2_utils/examples/example_conversion.cpp:118:127
--8<--
```

### `<autoware/lanelet2_utils/kind.hpp>`
### `kind`

| Function | Description | Average Computational Complexity | Illustration |
| ------------------ | ----------------------------------------------------------------------------- | -------------------------------- | ------------ |
Expand All @@ -334,7 +334,7 @@ common/autoware_lanelet2_utils/examples/example_kind.cpp:44:66
--8<--
```

### `<autoware/lanelet2_utils/hatched_road_markings.hpp>`
### `hatched_road_markings`

| Function | Description | Average Computational Complexity | Illustration |
| ------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- | ------------ |
Expand All @@ -348,7 +348,7 @@ common/autoware_lanelet2_utils/examples/example_hatched_road_markings.cpp:51:75
--8<--
```

### `<autoware/lanelet2_utils/topology.hpp>`
### `topology`

| Function | Description | Average Computational Complexity | Illustration |
| ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
Expand Down Expand Up @@ -490,7 +490,7 @@ common/autoware_lanelet2_utils/examples/example_topology.cpp:231:256
--8<--
```

### `<autoware/lanelet2_utils/intersection.hpp>`
### `intersection`

| Function | Description | Average Computational Complexity | Illustration |
| -------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | ------------ |
Expand Down Expand Up @@ -540,7 +540,7 @@ common/autoware_lanelet2_utils/examples/example_intersection.cpp:71:104
--8<--
```

### `<autoware/lanelet2_utils/lane_sequence.hpp`
### `lane_sequence`

| Function | Description | Average Computational Complexity | Illustration |
| --------------------------------- | --------------------------------------------------------------------------------------------------------- | -------------------------------- | ------------ |
Expand All @@ -567,7 +567,7 @@ common/autoware_lanelet2_utils/examples/example_lane_sequence.cpp:68:80
--8<--
```

### `<autoware/lanelet2_utils/nn_search.hpp>`
### `nn_search`

| Function | Description | Average Computational Complexity | Illustration |
| -------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------ |
Expand Down Expand Up @@ -623,7 +623,7 @@ common/autoware_lanelet2_utils/examples/example_nn_search.cpp:115:121
--8<--
```

### `<autoware/lanelet2_utils/map_handler.hpp>`
### `map_handler`

| Function | Description | Average Computational Complexity | Illustration |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
Expand Down Expand Up @@ -706,7 +706,7 @@ common/autoware_lanelet2_utils/examples/example_map_handler.cpp:140:146
--8<--
```

### `<autoware/lanelet2_utils/route_manager.hpp>`
### `route_manager`

| Function | Description | Average Computational Complexity | Illustration |
| ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
Expand Down
Loading