DocFX Reviews

Cppcheck Reviews

DocFX mentions (7)

• TSDocs.dev: type docs for any JavaScript library

  This is a better looking version of what Java and C# have had for a long time (kudos to the author for that!), is that the inspiration for this tool? https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html https://dotnet.github.io/docfx/ I saw the author mentioned in another comment that they found themselves peeping inside type declaration files "too often". While I do often use sites generated... - Source: Hacker News / 6 months ago

• What Does Microsoft Use to Create their KB Articles?

  Actually, we use it for OptiTune, it's called "docfx" https://dotnet.github.io/docfx/. Source: over 2 years ago

• Library / Codebase Documentation - Multiple aggregated libraries - How to create? DocFx does not support this?

  We would really prefer to use a somewhat generic pre-made tool for this (such as DocFX) compared to rolling our own solution. We can roll our own solution... But would prefer not to so that we can minimize development and maintenance overhead. Source: over 2 years ago

• CSharp Docuementation Site

  I use docfx from microsoft to generate documentation for all my oss libraries. Source: over 2 years ago

• What platform is Microsoft Docs hosted on?

  My best guess would be that there's a CI/CD pipeline in GitHub that utilizes DocFX to convert the Markdown files to HTML. The constructed HTML files are then placed in an Azure Storage account that configured for Static Website Hosting combined with Azure CDN. Source: almost 3 years ago

Cppcheck mentions (10)

• Configuring Cppcheck, Cpplint, and JSON Lint

  I dedicated Sunday morning to going over the documentation of the linters we use in the project. The goal was to understand all options and use them in the best way for our project. Seeing their manuals side by side was nice because even very similar things are solved differently. Cppcheck is the most configurable and best documented; JSON Lint lies at the other end. - Source: dev.to / 4 months ago

• Enforcing Memory Safety?

  Using infer, someone else exploited null-dereference checks to introduce simple affine types in C++. Cppcheck also checks for null-dereferences. Unfortunately, that approach means that borrow-counting references have a larger sizeof than non-borrow counting references, so optimizing the count away potentially changes the semantics of a program which introduces a whole new way of writing subtly wrong code. Source: about 1 year ago

• Static Code analysis

  For my own projects, I used cppcheck. You can check out that tool to get a feel. Depending on what industry your in, you might need to follow a standard like Misra. Source: about 1 year ago

• How do you not shoot yourself in the foot ?

  Https://cppcheck.sourceforge.io/ (there are many other static analysis tools, I just haven't used them or didn't care for them). Source: about 1 year ago

• Linting tool for prohibiting the use of specific std types

  Sounds like something that could simply be communicated with the team that writes the tests. Unless you have dozens of such classes. In that case, you could just use e.g. Cppcheck and add a rule (regular expression) that searches for usages of the forbidden classes. Source: over 1 year ago