Comments (1)
All tags can be attached to any code object (classs, module, method). In some cases they may seem non-sensical, the obvious examples being @param or @return for a class, however they are being recognized and stored. If a tag does not appear in documentation, this is not because the tag was ignored, instead it is most likely that there is no template to show the tag in documentation and a bug should be filed for that instead.
from yard.
Related Issues (20)
- yield_handler_spec.rb test fails with recent ruby3.3.0dev HOT 5
- `.yardopts` refuses filenames containing non-ASCII characters HOT 1
- Documented classes missing from generated class_list.html but present in generated alphabetical index.
- Unicode characters breaks YARD generation
- RangeError When using pattern matching in YARD documentation generation HOT 2
- Attribute source code
- Wrong documentation for order-dependent lists. HOT 1
- Remove OpenStruct HOT 3
- Documenting constants defined in a Ruby C extension
- `yard server` ignores `--query`
- Commonmarker 1.0 support HOT 1
- Do you know where the file plugins/yard_plugin.rb is coming from? HOT 1
- Global search - how it works? HOT 2
- What is the proper way to document a class returned from Data.define? HOT 8
- How is !group directive working? HOT 6
- Error on case statement parsing HOT 1
- Expand path non-absolute home HOT 8
- Any way to ignore Undocumentable? HOT 5
- difference in behavior, MacOS vs Linux/CI HOT 3
- Bug: deconstruction + array of symbols
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from yard.