-
Notifications
You must be signed in to change notification settings - Fork 9
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.
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
[SUGGESTION] Skriptdocs #43
Comments
Thanks for your suggestion! That's already planned. If I remember correctly, @GliczDev wants to add this into the Analyzer. |
Hmm, I think I was wrong, he only mentioned that it could be a separate addon. So yeah, I'll probably start working on it. |
And can you please make it when you type like triple # or double or something so it puts them auto then you type the params description and description of function and return type |
Yeah, I want to add it |
* Fix session restoring crash * Fix syntax loading crash * fix: need to double close skeditor with session restore * update libs * fix: code parser yml crash and wrong section end * Add real-time code parsing experiment * fix: syntax crash * Added proper indentation pasting (#43) * Added proper indentation pasting (#16) * Added config option for paste indent + reworked bindings for settings * Change auto-indent paste option order in the settings * correct auto-indent option translation * Bump version to v2.5.0 * First push * supports for SkUnity as provider added basic search form added search validation for a provider added timeout system when sending the request to the provider first appearance of SkriptHub provider (will be next) * Added supports for SkriptHub * ✨ Added Connections page (and regrouped SkUnity key there) * Custom provider keys system * ✨ Added loading bar & warning when >= 100 results * ✨ Added examples endpoints * ✨ Added example and example fetching for some providers * ✨ Added 'Classe' type and fixed doc type parsing * ✨ Added a useful message for too many results/nothing found/etc... * ✨ Added auto complete box for addons * ✨ Added local docs provider (= download docs for offline use) * ⚡ Enhanced usage of examples to give the whole object instead of just the ID * ✨ (Theoretically) Added SkriptMC docs provider * ✨ Moved publish's API keys to the new Connections settings page * ✨ Added event-values & expression changers (+ pattern generator for changers) * 🐛 Fixed error when no examples were available * ⚡ Enhanced connections page using sub-controls * 🐛 Fixed empty changers showing blank buttons * 📝 Review changes * Add connection providers svg icon support, cleanup * ✨ Added local docs management window ✨ Added button to refresh providers ⚡ Added FluentIcons to SkEditor & enhanced element's icons * ⚡ A Lot of cleanup (Notro will be happy now XD) * ⚡ Replaced ivon of doc management entry by a text * ⚡ Replaced icon from Avalonia to FluentIcons * 🐛 Fixed wrong size of the delete button * Fix experiments settings page title, change warning * Remove code unparsed info from the code parser * ✨ Added much better download buttons for doc elements * ✨ Added bunch-download for elements * ⚡ Fixed doc provider type in the local doc manager * ✨ Added lang to the new documentation system * change selection color in documentation editors * ✨ Added colors to doc entry's icon + better addon badge color/link * Make loading addons a little bit faster * make loading addons a little bit faster * Move doc pattern syntax logic to its own class * cleanup * Refactor GetTypeIcon method * update libs --------- Co-authored-by: Sky <[email protected]> Co-authored-by: Sky <[email protected]>
* Fix session restoring crash * Fix syntax loading crash * fix: need to double close skeditor with session restore * update libs * fix: code parser yml crash and wrong section end * Add real-time code parsing experiment * fix: syntax crash * Added proper indentation pasting (#43) * Added proper indentation pasting (#16) * Added config option for paste indent + reworked bindings for settings * Change auto-indent paste option order in the settings * correct auto-indent option translation * Bump version to v2.5.0 * First push * supports for SkUnity as provider added basic search form added search validation for a provider added timeout system when sending the request to the provider first appearance of SkriptHub provider (will be next) * Added supports for SkriptHub * ✨ Added Connections page (and regrouped SkUnity key there) * Custom provider keys system * ✨ Added loading bar & warning when >= 100 results * ✨ Added examples endpoints * ✨ Added example and example fetching for some providers * ✨ Added 'Classe' type and fixed doc type parsing * ✨ Added a useful message for too many results/nothing found/etc... * ✨ Added auto complete box for addons * ✨ Added local docs provider (= download docs for offline use) * ⚡ Enhanced usage of examples to give the whole object instead of just the ID * ✨ (Theoretically) Added SkriptMC docs provider * ✨ Moved publish's API keys to the new Connections settings page * ✨ Added event-values & expression changers (+ pattern generator for changers) * 🐛 Fixed error when no examples were available * ⚡ Enhanced connections page using sub-controls * 🐛 Fixed empty changers showing blank buttons * 📝 Review changes * Add connection providers svg icon support, cleanup * ✨ Added local docs management window ✨ Added button to refresh providers ⚡ Added FluentIcons to SkEditor & enhanced element's icons * ⚡ A Lot of cleanup (Notro will be happy now XD) * ⚡ Replaced ivon of doc management entry by a text * ⚡ Replaced icon from Avalonia to FluentIcons * 🐛 Fixed wrong size of the delete button * Fix experiments settings page title, change warning * Remove code unparsed info from the code parser * ✨ Added much better download buttons for doc elements * ✨ Added bunch-download for elements * ⚡ Fixed doc provider type in the local doc manager * ✨ Added lang to the new documentation system * change selection color in documentation editors * ✨ Added colors to doc entry's icon + better addon badge color/link * Addons now provides a whole IconSource instead of just a Symbol * ✨ Added Registry class to better handle registration * ✨ Refactored registry & registry keys & added Registries class * ✨ Added Third-Party Connections Registry * ⚡ Re-added default connections by creating an addon for self SkEditor * ⚡ Added addon icon & description * :spakles: Reworked the Addons page to displays a *real* addon managing system (WIP) * Make loading addons a little bit faster * make loading addons a little bit faster * Move doc pattern syntax logic to its own class * cleanup * Refactor GetTypeIcon method * update libs * 📝 Added C# Docs & new event to IAddon class * 🚀 Refactored logs & windows + addons can be deleted via the addons tab * push for notro * removed debug + cleanup * ✨ Added bottom bar supports for addons * ✨ Added on file open event * ✨ Added on file open event * 🚀 Lot of docs-related changes: - Enhanced SkriptHub docs system - Added icons to type & providers dropdown - Added a button to access the desired element on the web * 🐛 Fixed overlapping error message & search results * ✨ Added colored preview for item's name & lore * ✨ Added wider item selector window & icons to the list of items * ⚡ Changed GUI item icon size, text align & fixed searching items * ⚡ Changed item & icon spacing to 10 * ✨ Added sidebar registry for addons * ⚡ Made SkEditorAPI fields read-only * ⚡ Fixed addon's icon in the addon header menu * ✨ Added 'Addons' API * 🚀 Completely reworked addons loading * :za: Version of the app now returns major, minor and build only * 🔥 Removed debug messages * ✨ Added a menu item in the "Addons" header to manage addons * ⚡ Refactored every getters of AppConfig into the new SkEditorAPI access * ✨ Dependencies system but it doesn't work (yet) * 🔥 Removed SkriptHub API key option as it's not required anymore * 🐛 Fixed examples not loading + enhanced addons fetch * ⚡ Made loading each entry element async to not create a lag spike when loading a lot of elements * ✨ Yay! finally working dependency downloading for addons * ✨ Added custom addons settings page & toggle/string setting * 🚀 Omfg so much things! - Reworked how Files (= tabs/editors) were saved and organized - Added the 'Files' API interface - Refactored methods of SkEditor that were using old ApiVault system in favor of SkEditorAPI * ✨ Added welcome tab & SpacedGrid package * ✨ Fixed/enhanced session restorer system * 🔥 Removed session restored quick access key * 🔥 Removed (again) debugs from Session Restorer * 🐛 Fixed addon loading folders that are just here with settings * ✨ Added way for addons to register entries in the welcome tab * ✨ Added a grid splitter for the sidebar * ✨ Added utilities methods, fixed settings types, fixed addon item in marketplace, fixed deleting addons, added way to load an addon from its dll file * ✨ Added logs window * 🔥 Removed SkriptHub connection as it's not required anymore * ⚡ Added margin to buttons when addon entry have settings * ✨ Added a developer mode option * ⚡ Used developer mode in addons page and for debug logs * ✨ Enhanced bottom icons classes * ⚡ Moved bottom buttons to the left and fixed line/column in welcome page * Make attached icon element invisible when icon source is null * Make BottomIconGroupData button enabled by default * Ignore .idea * Delete unused using statement that makes the publish to fail * Added a setting to open files/folders in single click in projects * Fixed path not found error on linux with the project explorer * ✨ Added sub-category setting type, some cleanup and enhancement about addons loading and logging * Remove every ApiVault usage and mark it as obsolete * Fix the LogsHandler crash * Change Registry folder name to plural * Fix merge errors * Fix merge errors * 🐛 Fixed crash when: - Loading an addon from files without selecting a file - Closing the welcome tab (or any other 'single' tab) * ⚡ Some classes were still using ApiVault * ✨ Added ShowWindow and ShowWindowAsDialog methods to the Windows API * 🚀 Dynamic margin system! Yay! * ✨ Made margin column system and made margin works with folding * 🐛 Fixes #75 * 🐛 Fixed Discord RPC deactivation crash & wrapper toggle that were not working * ✨ Docs now search directly when enter is pressed * 🚀 Much better crash system with displayed crash exception * ⚡ Added way to get a value's ID in registries * ✨ Sidebar panels width are now persistent within restarts and panels * ✨ Added new "single click action" setting for projects * changed app config usage in favor of SkEditorAPI in GeneralPage.axaml.cs * ⚡ Added back the binary file warning * ⚡ Optimized custom content support for opened files * ✨ Reworked the file type system to work with registries & the new file API * ✨ Added FullKey for a registry key * ✨ Update * ⚡ Separated items of general page into two categories * Fix trim whitespaces crash * Fix close dialog not having yes/no buttons * Fix dialog icon size * :fire Removed debugs + import cleanup * 🐛 Fixed addon's DLL still used after unloading * 🐛 Hotfix: categories for addon settings * ⚡ Passing OpenedFile object in the FileOpened event * ✨ Added new Color Setting type * 🐛 Fixed addon state change reloading * ⚡ Fixed installing an addon from the marketplace not refreshing self view once installed * Fix welcome tab closing crash * Change settings category seperator margin * Update libraries * Improve welcome tab * Update .editorconfig * cleanup * Make welcome tab use translation * Update Polish translation * Fix Save All feature * Shorten save all method * Fix about page data context * Fix syntax loading on offline mode * Try to fix project paths on Linux * Bump version * Remove interface casts * Add item image fallback, fix window lag in gui generator * Update marketplace info English translation * Remove debug log * Rename CustomClassData to CustomFileData * Fix syntax not loading * Shorten LoadingErrors class * Add prerelease check to update checker * Add informational version to the API * Change Ok to Yes in unsaved file dialog * Adjust sizes and margins in dialog * Update changelog * Add welcome tab logo tooltip * Handle invalid crash exception format * Improve crash window * Improve logs window * Make second hash in hex regex optional (Skript 2.9 syntax update) * Remove special pastes * Fix save as not working when file is saved * Fix file icons * Make change checker disabled by default * Fix save as * Downgrade avalonia (critical minimize bug) * Fix file icons * Correct package versions * Fix drag and drop * delete addon dependency log * Fix addon self managed settings crash * Update Avalonia * bump core addon minimal version * Add remove uncompatible addons feature * Add icons for welcome and documentation tab * Delete addon debug log * Make bottom bar icons smaller * Delete hidden items from marketplace --------- Co-authored-by: Sky <[email protected]> Co-authored-by: GliczDev <[email protected]>
Add skriptdocs system like the java docs, in java you can do
Add this to skript editor so it reads them and color them, and when you hover it shows what the function does and what parameters it requires as this
The text was updated successfully, but these errors were encountered: