Generated index.html in Sandcastle only includes first project - html

I'm using Sandcastle Help File Builder to document the projects in a C# solution. I have it generating HTML Help 1 as well as Website
The HTML Help 1 file generated (.chm) is fine, so I know the basic documentation build process is working, and I can see all my classes. The website is mostly fine, but it has one serious problem: The index.html only references one project (the first project, alphabetically). You can access any of the documentation for the other projects in the solution from the index.html file.
Anyone know how to fix the index.html file?

I solved this by checking "Enable namespace grouping if supported" option in the Help File section of Project Properties.

I know this is old. but i bump into this problem too.. I cant use "enable namespace goruping if supported" since its throwing an error..
I also notice that the heirarchy of the html files are
Help fileName
namespace 1
namespace is not under the help file name..
so i played with the tool and found out that when enabling on
"Include root namespace container" (dont enable "Enable namespace grouping if supported")
Right now it will give you a heirarchy of
Help file name
Title Name
namespace 1
namespace 2
namespace 1 and 2 is under tile name its under help file name

Related

Why I need to Rebuild whole solution when make change in razor cshtml file

I wonder why every time I need to rebuild whole solution when I make changes to .cshtml file to see changes on web. It takes so much time and it is annoying when I just want to check some minor change in html (for example adding <td> element into table which will be filled with value from model)
Please can somebody explain it to me? I'm not very experienced in this area and I want to understand it more :)
Late for the party?
I had the same issue in VS 2019 RC2 while working with out of the oven, still warm demo project based on the Razor Components App template. For each change to take effect I had to rebuild the project. I excluded browser cache issues and everything else I could think of or found mentioned on the web.
I found that in the .csproj file the razor file extensions was set to .cshtml:
<PropertyGroup>
<TargetFramework>netcoreapp3.0</TargetFramework>
<LangVersion>7.3</LangVersion>
<_RazorComponentInclude>Components\**\*.*cshtml*;</_RazorComponentInclude>
</PropertyGroup>
...while the actual file extensions were .razor. After renaming the .razor files to have .cshtml extension everything worked as expected.
Note, it didn't work the other way around, editing the .csproj file to look for .razor extension because there was a conflict in two stock .target files that I didn't want to touch.
That depends on the change.
If it is a razor change, yes you need to build (compile dlls). If it is not, that you don't.
Razor syntax is a view syntax of c#. It is used in views and transformed into html via the Razor View Engine.
By being C# code, you need to generate it's IL by doing a build or rebuild. Basically you are telling the compiler to generate a new IL based on your changes. Than the web server uses the dlls to run the app.

Class file editor : Source not found error for ILock, ClassPathSuite classes

I am getting Class file editor : Source not found error for the classes in junit / hazelcast packages. Previously i got this error for all built in java classes. But after adding the Source zip file, i am able to see String.class and all. What i need to do for these classes. Please find the screenshot
Thanks in Advance!
Interestingly enough, your question contains all the concepts you need to know in order to answer it.
In order for your IDE to show you source code for any library you are using, the corresponding library needs to come with source code attached to it.
In other words: you managed to point your IDE to the ZIP file containing the source code for your JRE/JDK - thus your IDE knows what to show you when want to open up String.class
Now it seems that you are using other libraries as well. Maybe maybe, other libraries, have other, different source code ZIP files?!
Long story short: you need to add "source code" ZIPs for each and any additional library you are using and that you want to "peek into".
Within eclipse, you achieve that for example as described in that SO q/a. Side note: that is also something to keep in mind: you should do prior research before coming up with "new" questions. Especially when you are a beginner, you can be very sure that "your" question was asked here before.

Incorrect Paths for an Imported Flex Project

I'm trying to import someone else's Flex project folder into Flash Builder 4.5, and I'm having some problems with the paths. When I load everything up, I'm getting errors that say that the "Type was not found or was not a compile-time constant" for all the .as files living in src. It looks like based on the path settings, it cannot find those files.
So I went to the Package > Properties and tried to add the src folder to the Source Path list, but no luck there either.
One curious thing is that when I look at the error at the bottom, I see Path is set to /ProjectName/src/. Is that an absolute path? Certainly it wouldn't find them if it were.
Can anyone shed some light on getting my Flex project to find my src folder?
Thanks,
Whit
/ProjectName/foo/bar in Flash Builder would be resolved to the project's foo/bar directory, therefore it is not an absolute path.
The project you experience may also have to do with the libraries (SWCs) referenced by your project are not properly referenced. You may go to Project -> Properties -> Flex Build Path -> Library path (tab) and add reference to libraries similar to the fashion you add the Source Path.
Additionally, when source path is correctly added, you would also notice a "virtual folder" appearing in the referencing project, which allows you to directly load and edit the source code of the referenced project.

Getting Type not found error implementing source in as3

I am trying to just compile and run the demos from this article:
Flash talks to max msp via osc
I am using Flash Develop and Flex SDK with an up to date version of air.
When I run the demo: "as3_MaxFlashHarmony" I get an error I don't know how to fix. The source for the entire project is here:
the project
But specifically the error I am getting says:
col: 30 Error: Type was not found or was not a compile-time constant: OSCMessage.
here is the as3 file that it is specifically referencing:
//IHarmonyApp.as
package
{
import org.tuio.osc.OSCMessage;
public interface IHarmonyApp
{
function updateOSCData(msg:OSCMessage):void;
}
}
It uses the libraries Tuio, MinimalComps, and MonsterDebugger. The thing I don't get is that how can it not find OSCMessage if OSCMessage is properly imported? the IDE is making fine references to it and I can open it's declaration. OSCMessage is a public class. I don't get it.
To give some extra info for potential answers, the IDE flashdevelop can find the library org.tuio.osc.OSCMessage just fine, it gives the error regardless of if org.tuio... is a source path or not, and the overall path does not contain any special characters. I don't know if that might matter, but I feel like this is me making a stupid mistake somewhere. I can provide my project zipped if need be.
Thanks!
Edit 9:48, 8/25/12
I do have the file path org/tuio/osc/OSCMessage.as in my project, and the file OSCMessage exists. FlashDevelop can find it just fine and I can navigate to declaration at that location. This is why I got stumped.
Thanks again
In your AS3 folder apart of your de folder you would need to have org folder with relevant folders and classes.
For example to import org.tuio.osc.OSCMessage you would need a file:
../YourPackageRoot/org/tuio/osc/OSCMessage.as
The other way is including a SWC file (all folders and classes zipped into one swc file).
You can include the swc file in FlashDevelop by right clicking the swc file and selecting Add To Library

ReSharper: Namespace does not correspond to file location

I renamed a folder and updated my namespace declarations, but ReSharper 6 claims that the namespace should be a reflection of how it was before the rename. Where is it storing the file location data?
Check to make sure your assembly name matches your new namespace. If you've changed your folder structure to match your new namespace, you may still see the ReSharper alert until you update the project properties.
As delliottg's comment says, in Visual Studio, go to
Project > [project name] Properties > Application
and change "Assembly name" as well as "Default namespace".
I also had this problem with a folder/namespace and none of the above steps fixed it.
In my case I had to do this in Visual Studio:
Right-click the "problem" folder in the solution explorer to open the properties
Ensure the "Namespace Provider" is set to true
This fixed the ReSharper issue for me and I was able to adjust namespaces as normal.
Root namespace is needed to be changed as following.
I use Resharper 2019.3.2 in VS 2019 vs 16.5.2 and I had similar issues.
When developing, I first work out my namespace hierarchy in a single project, then split the project in seperate class libraries. In the first stage, it is convenient to always let the subdirectory correspond to the namespace.
For example, my prototype MeshTools.dll project currently contains:
Meshtools ........................ 3 cs-files in \MeshTools
MeshTools.HeightField .......... 2 cs-files in \MeshTools\HeightField
MeshTools.VectorTools .......... 3 cs-files in \MeshTools\VectorTools
The above answers all assume one single namespace per project. Renaming directories manually may confuse Resharper and that can be repaired by setting the default assembly in the .csproj file to the proper namespace. Thanks for the tip.
However in my case, I have several namespaces in a single project, with each namespace in a Solution directory corresponding to a real directory. Setting the default assembly "Meshtools" does not affect ReSharper behaviour for HeightField and VectorTools, when things have gone wrong with the renaming.
I googled this issue and came by https://www.jetbrains.com/help/resharper/Refactorings__Adjust_Namespaces.html#
It turns out there is a right-click option on a Solution Directory -> Properties. You will find an option to decide, if the Solution Directory is a NameSpace provider or not. When something has gone wrong, Visual studio will reset the field to False. Set it back to True and Resharper will correctly refactor namespace or file location when needed..
If you're using JetBrains Rider, go to the Solution Explorer and right click on the csproj file, then properties in the context menu. In my case the Assembly Name was already updated but "Root Namespace" wasn't, updating Root Namespace allowed JetBrains to automatically update all namespaces.