format_java_method(route) ::= << <method_title(route)> <route.operation.description> <method_type_reference(route)> <if(route.paramHelpers)><method_parameters(route.paramHelpers)><endif> <method_response(route)> >> method_title(route) ::= << [[java-<route.javaClassReferenceId>-<route.javaMethodReferenceId>]] ===== <route.javaClassShortName>#<route.javaMethodName> >> method_type_reference(route) ::= << .Package Name [source,java] .... com.perforce.hwsclient .... .Method Signature [source,java] .... <route.successResponseJavaType> <route.javaClassShortName>#<route.javaMethodName>(<if(route.paramHelpers)><route.paramHelpers:format_parameter_declaration(); separator=", "><endif>) .... >> method_parameters(paramHelpers) ::= << .Parameters [cols="1,1,2a", options="header"] |=== | Type | Name | Description <paramHelpers:method_parameter()> |=== >> method_parameter(paramHelper) ::= << | <paramHelper.javaTypeRef> | <paramHelper.name> | <paramHelper.description> >> format_parameter_declaration(paramHelper) ::= "<paramHelper.javaType> <paramHelper.name>" method_response(route) ::= << .Returns [cols="1,2a", options="header"] |=== | Type | Notes | <route.successResponseJavaTypeRef> | <route.successResponseDescription> |=== >> java_model(model) ::= << <model_title(model)> <model.model.description> <if(model.propertyHelpers)><model_properties(model)><endif> >> model_title(model) ::= << [[java-model-<model.idRef>]] ===== <model.id> >> model_properties(model) ::= << .Properties [cols="1,1,2a", options="header"] |=== | Type | Name | Description <model.propertyHelpers:model_property()> |=== >> model_property(propertyHelper) ::= << | <propertyHelper.javaTypeRef> | <propertyHelper.id> | <propertyHelper.property.description> >>
# | Change | User | Description | Committed | |
---|---|---|---|---|---|
#9 | 19535 | drobins | Refactor package names to hws | ||
#8 | 19203 | tjuricek | Correct the column styling header to avoid the assumption that a 3-column display actually has more columns | ||
#7 | 19202 | tjuricek | Revised documentation for the Ruby Client SDK; removed obsolete methods and definitions, and restyled a lot of the tables. | ||
#6 | 19029 | tjuricek |
Generate model references when models are properties of other models in documentation. Workaround asciidoc getting thrown off by pipe symbols in the documentation. |
||
#5 | 19018 | tjuricek | Adjust the "method signature" code block to not use a link to model objects. | ||
#4 | 19016 | tjuricek |
Rename 'test-' jobs to 'verify-' to change CD behavior, and adjust TestNG to not skip tests if a configuration failure happens. The current CD system actually just treats configuration failures as "passes". The TestNG change will now execute dependent tests if a configuration failure happens... which should result in a test failure. The MCL script changes will now break all verification runs if any fail. |
||
#3 | 19012 | tjuricek | Revised Java client SDK, added ApiClient reference, restructured documentation. | ||
#2 | 19010 | tjuricek |
Reorganize the main information flow of the documentation. The HTTP Method Reference was moved towards the end, since it is probably only going to be referenced for creating a new client SDK. Sections were added for "models" for each language. |
||
#1 | 18924 | tjuricek |
First cut at including the Java client SDK docs as part of the main guide. This includes a new "object model" that knows how to generally convert to the different Java types, which greatly simplifies the templating logic. The final result is likely going to need some real ironing out. I'm going to basically get things wired up, and iterate on overall format and styling once all languages are represented. |