{"repo":"benui-dev/UE-Specifier-Docs","free":true,"listed":false,"github":"https://github.com/benui-dev/UE-Specifier-Docs","clone":"git clone https://github.com/benui-dev/UE-Specifier-Docs.git","description":"YAML files used for Unreal Engine specifier docs on benui.ca","language":"C++","stars":69,"topics":["documentation","engine","ue4","ue5","unreal","unreal-engine"],"license":"Apache-2.0","category":"docs-static-sites","readme_excerpt":"Unreal Engine Specifiers This repo contains the YAML files and images used to generate the property specifier documentation pages on benui.ca: UPROPERTY UFUNCTION UPARAM UCLASS USTRUCT UENUM and UMETA I've made them open-source so people can submit pull requests, make forks, or publish their own versions of the documentation. Example entry: Format Description I try to keep the comment field less like strict documentation and more tutorial-like; talking about why you'd want to use the specifier and potential edge-cases. Property Name Data Type Required? Notes --- --- --- --- name string Required Plain text. I try to camelcase even though the name is technically case-insensitive. group string Arbitrary string I use to display related specifiers together. subgroup string Requires group A way of categorizing specifiers further within a group. position string Required Valid values are main or meta . utility integer Value between 1-3. 3 is for extremely-commonly-used specifiers, 1 is for niche or rarely-used specifiers. type string Required Valid values are flag , string , number , bool , integer . type-comment string Requires type Extra information about the type. For example if the string must be the name of a valid UPROPERTY member variable, or number must be an integer. comment string Long free-text description on how to use the specifier. Includes Markdown formatting. samples string array An array of code snippets that show how the specifier is used. required specifier array A","default_branch":null,"files":null,"tree":[],"storefront":"/r/benui-dev","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/benui-dev/UE-Specifier-Docs/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}