Comments (6)
Keeping the docs separate from the dll also allows for the possibility of localization where the projection produces docs in the author or project's preferred language rather than always English.
from win32metadata.
FYI @asklar has been experimenting with doing this for WinRT APIs.
from win32metadata.
The C# projection uses this tool to scrape docs into YAML for inclusion as xml doc comments in the C#-produced APIs.
It's intended to be shareable. We could move that tool into this repo if that's helpful.
from win32metadata.
I think we will want to use the same approach we'll use for cswinrt where we'd use roslyn to turn XML comments into a custom attribute in the winmd, that can be read by any number of tools.
from win32metadata.
The docs are 50+ MBs, @asklar. I'd rather the metadata dll not be so huge. In fact, I hear that assemblies have a max size (or 10MB?) for how much space can be spent on strings, so it may be technically impossible to put all the docs in the assembly as custom attributes.
I think the docs should remain outside the metadata dll.
from win32metadata.
FWIW localization can be baked into the custom property, just like classic COM did helpstringdll / helpstringcontext (an ID and a DLL)
from win32metadata.
Related Issues (20)
- RPC_S_ACCESS_DENIED has wrong value HOT 3
- Possible bug using REGSTR_PATH_UNINSTALL under 32bit Windows HOT 2
- ConstantsScraper: Using `--with-type` with a constant that has a shift produces bad code
- FILE_INFORMATION_CLASS values seems impoper. HOT 5
- Add a way to convert from `HGDIOBJ` to `HBRUSH` HOT 2
- `MOUSEINPUT` is of the wrong type HOT 8
- Cannot generate `IPrintDocumentPageSource` and `IPrintPreviewPageCollection` HOT 1
- Missing D3DX functions
- Missing some `Threadpool` APIs HOT 8
- 1.613.0 AgilitySDK metadata update HOT 4
- `RecompileIdlFilesForScraping` does not run on a clean repo HOT 3
- `WNetAddConnection2W` and `WNetCancelConnection2W` should accept `NET_USE_CONNECT_FLAGS` enumeration instead of `uint` as `dwFlags`
- Possibly add SEH wrapping through linked libs HOT 8
- `IFileDialogEvents` methods must return `HRESULT`
- Update win32metadata for AgilitySDK 1.613.1 (minor release)
- GetProcessHandleFromHwnd missing from SDK, metadata HOT 6
- WinMD TypeRef Metadata length of table HOT 1
- COINIT documentation is wrong HOT 3
- Function entrypoint Apis missing from winmd HOT 2
- Cannot specify `cString` in `ScriptStringAnalyse` HOT 14
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 win32metadata.