Skip to content

Commit

Permalink
Fix the generated links to things with CamelCase names (#124)
Browse files Browse the repository at this point in the history
  • Loading branch information
bsilver8192 authored Mar 7, 2022
1 parent cdd1937 commit 4d5b5da
Show file tree
Hide file tree
Showing 39 changed files with 80 additions and 80 deletions.
2 changes: 1 addition & 1 deletion docs/stardoc_rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Starlark rule for stardoc: a documentation generator tool written in Java.

<a id="#stardoc"></a>
<a id="stardoc"></a>

## stardoc

Expand Down
2 changes: 1 addition & 1 deletion stardoc/templates/html_tables/aspect.vm
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<a id="#${aspectName}"></a>
<a id="${aspectName}"></a>

#[[##]]# ${aspectName}

Expand Down
2 changes: 1 addition & 1 deletion stardoc/templates/html_tables/func.vm
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<a id="#${funcInfo.functionName}"></a>
<a id="${funcInfo.functionName}"></a>

#[[##]]# ${funcInfo.functionName}

Expand Down
2 changes: 1 addition & 1 deletion stardoc/templates/html_tables/provider.vm
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<a id="#${providerName}"></a>
<a id="${providerName}"></a>

#[[##]]# ${providerName}

Expand Down
2 changes: 1 addition & 1 deletion stardoc/templates/html_tables/rule.vm
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<a id="#${ruleName}"></a>
<a id="${ruleName}"></a>

#[[##]]# ${ruleName}

Expand Down
2 changes: 1 addition & 1 deletion stardoc/templates/markdown_tables/aspect.vm
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<a id="#${aspectName}"></a>
<a id="${aspectName}"></a>

#[[##]]# ${aspectName}

Expand Down
2 changes: 1 addition & 1 deletion stardoc/templates/markdown_tables/func.vm
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<a id="#${funcInfo.functionName}"></a>
<a id="${funcInfo.functionName}"></a>

#[[##]]# ${funcInfo.functionName}

Expand Down
2 changes: 1 addition & 1 deletion stardoc/templates/markdown_tables/provider.vm
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<a id="#${providerName}"></a>
<a id="${providerName}"></a>

#[[##]]# ${providerName}

Expand Down
2 changes: 1 addition & 1 deletion stardoc/templates/markdown_tables/rule.vm
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<a id="#${ruleName}"></a>
<a id="${ruleName}"></a>

#[[##]]# ${ruleName}

Expand Down
2 changes: 1 addition & 1 deletion test/testdata/android_basic_test/golden.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@



<a id="#android_related_rule"></a>
<a id="android_related_rule"></a>

## android_related_rule

Expand Down
6 changes: 3 additions & 3 deletions test/testdata/angle_bracket_test/golden.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Input file to test angle bracket bug (https://github.com/bazelbuild/skydoc/issues/186)

<a id="#my_anglebrac"></a>
<a id="my_anglebrac"></a>

## my_anglebrac

Expand All @@ -21,7 +21,7 @@ Rule with <brackets>
| <a id="my_anglebrac-useless"></a>useless | Args with some tags: &lt;tag1&gt;, &lt;tag2&gt; | String | optional | "Find <brackets>" |


<a id="#bracketuse"></a>
<a id="bracketuse"></a>

## bracketuse

Expand All @@ -41,7 +41,7 @@ Information with <brackets>
| <a id="bracketuse-baz"></a>baz | A string representing baz |


<a id="#bracket_function"></a>
<a id="bracket_function"></a>

## bracket_function

Expand Down
2 changes: 1 addition & 1 deletion test/testdata/apple_basic_test/golden.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@



<a id="#apple_related_rule"></a>
<a id="apple_related_rule"></a>

## apple_related_rule

Expand Down
6 changes: 3 additions & 3 deletions test/testdata/aspect_test/golden.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The input file for the aspect test

<a id="#my_aspect_impl"></a>
<a id="my_aspect_impl"></a>

## my_aspect_impl

Expand All @@ -20,7 +20,7 @@ my_aspect_impl(<a href="#my_aspect_impl-ctx">ctx</a>)
| <a id="my_aspect_impl-ctx"></a>ctx | <p align="center"> - </p> | none |


<a id="#my_aspect"></a>
<a id="my_aspect"></a>

## my_aspect

Expand Down Expand Up @@ -49,7 +49,7 @@ This is my aspect. It does stuff.
| <a id="my_aspect-second"></a>second | - | <a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a> | required | |


<a id="#other_aspect"></a>
<a id="other_aspect"></a>

## other_aspect

Expand Down
4 changes: 2 additions & 2 deletions test/testdata/attribute_defaults_test/golden.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

A golden test to verify attribute default values.

<a id="#my_rule"></a>
<a id="my_rule"></a>

## my_rule

Expand Down Expand Up @@ -43,7 +43,7 @@ This is my rule. It does stuff.
| <a id="my_rule-w"></a>w | - | Integer | optional | 0 |


<a id="#my_aspect"></a>
<a id="my_aspect"></a>

## my_aspect

Expand Down
2 changes: 1 addition & 1 deletion test/testdata/attribute_types_test/golden.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@



<a id="#my_rule"></a>
<a id="my_rule"></a>

## my_rule

Expand Down
6 changes: 3 additions & 3 deletions test/testdata/cc_api_test/golden.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Input file for C++ api test

<a id="#cpp_related_rule"></a>
<a id="cpp_related_rule"></a>

## cpp_related_rule

Expand All @@ -24,7 +24,7 @@ This rule does C++-related things.
| <a id="cpp_related_rule-third"></a>third | - | <a href="https://bazel.build/docs/build-ref.html#labels">Label</a> | required | |


<a id="#exercise_the_api"></a>
<a id="exercise_the_api"></a>

## exercise_the_api

Expand All @@ -36,7 +36,7 @@ exercise_the_api()



<a id="#my_rule_impl"></a>
<a id="my_rule_impl"></a>

## my_rule_impl

Expand Down
8 changes: 4 additions & 4 deletions test/testdata/config_apis_test/golden.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@



<a id="#int_setting"></a>
<a id="int_setting"></a>

## int_setting

Expand All @@ -20,7 +20,7 @@ An integer flag.
| <a id="int_setting-name"></a>name | A unique name for this target. | <a href="https://bazel.build/docs/build-ref.html#name">Name</a> | required | |


<a id="#string_flag"></a>
<a id="string_flag"></a>

## string_flag

Expand All @@ -38,7 +38,7 @@ A string flag.
| <a id="string_flag-name"></a>name | A unique name for this target. | <a href="https://bazel.build/docs/build-ref.html#name">Name</a> | required | |


<a id="#exercise_the_api"></a>
<a id="exercise_the_api"></a>

## exercise_the_api

Expand All @@ -50,7 +50,7 @@ exercise_the_api()



<a id="#transition_func"></a>
<a id="transition_func"></a>

## transition_func

Expand Down
2 changes: 1 addition & 1 deletion test/testdata/cpp_basic_test/golden.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@



<a id="#cpp_related_rule"></a>
<a id="cpp_related_rule"></a>

## cpp_related_rule

Expand Down
4 changes: 2 additions & 2 deletions test/testdata/filter_rules_test/golden.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@



<a id="#my_rule"></a>
<a id="my_rule"></a>

## my_rule

Expand All @@ -22,7 +22,7 @@ This is my rule. It does stuff.
| <a id="my_rule-second"></a>second | - | <a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a> | required | |


<a id="#whitelisted_dep_rule"></a>
<a id="whitelisted_dep_rule"></a>

## whitelisted_dep_rule

Expand Down
8 changes: 4 additions & 4 deletions test/testdata/function_basic_test/golden.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

A test that verifies basic user function documentation.

<a id="#check_sources"></a>
<a id="check_sources"></a>

## check_sources

Expand Down Expand Up @@ -32,7 +32,7 @@ Use `bazel build` to run the check.
| <a id="check_sources-struct_param"></a>struct_param | <p align="center"> - </p> | <code>struct(foo = "bar")</code> |


<a id="#deprecated_do_not_use"></a>
<a id="deprecated_do_not_use"></a>

## deprecated_do_not_use

Expand All @@ -48,7 +48,7 @@ This function is deprecated.
Use literally anything but this function.


<a id="#returns_a_thing"></a>
<a id="returns_a_thing"></a>

## returns_a_thing

Expand All @@ -70,7 +70,7 @@ Returns a suffixed name.
A suffixed version of the name.


<a id="#undocumented_function"></a>
<a id="undocumented_function"></a>

## undocumented_function

Expand Down
2 changes: 1 addition & 1 deletion test/testdata/generated_bzl_test/golden.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

A direct dependency file of the input file.

<a id="#my_rule"></a>
<a id="my_rule"></a>

## my_rule

Expand Down
8 changes: 4 additions & 4 deletions test/testdata/html_tables_template_test/golden.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Input file for markdown template test

<a id="#example_rule"></a>
<a id="example_rule"></a>

## example_rule

Expand Down Expand Up @@ -58,7 +58,7 @@ String; optional
</table>


<a id="#ExampleProviderInfo"></a>
<a id="ExampleProviderInfo"></a>

## ExampleProviderInfo

Expand Down Expand Up @@ -110,7 +110,7 @@ A string representing baz
</table>


<a id="#example_function"></a>
<a id="example_function"></a>

## example_function

Expand Down Expand Up @@ -159,7 +159,7 @@ This parameter does bar related things.
</table>


<a id="#example_aspect"></a>
<a id="example_aspect"></a>

## example_aspect

Expand Down
2 changes: 1 addition & 1 deletion test/testdata/java_basic_test/golden.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@



<a id="#java_related_rule"></a>
<a id="java_related_rule"></a>

## java_related_rule

Expand Down
2 changes: 1 addition & 1 deletion test/testdata/local_repository_test/golden.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

A test that verifies documenting functions in an input file under a local_repository.

<a id="#min"></a>
<a id="min"></a>

## min

Expand Down
6 changes: 3 additions & 3 deletions test/testdata/macro_kwargs_test/golden.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Tests for functions which use *args or **kwargs

<a id="#macro_with_args"></a>
<a id="macro_with_args"></a>

## macro_with_args

Expand All @@ -25,7 +25,7 @@ My args macro is OK.
An empty list.


<a id="#macro_with_both"></a>
<a id="macro_with_both"></a>

## macro_with_both

Expand Down Expand Up @@ -53,7 +53,7 @@ Not much else to say.
An empty list.


<a id="#macro_with_kwargs"></a>
<a id="macro_with_kwargs"></a>

## macro_with_kwargs

Expand Down
Loading

0 comments on commit 4d5b5da

Please sign in to comment.