I'm trying to use Doxygen to generate documentation for a project I'm doing in D. However, it only seems to pick up my README.md file and none of my source files, even though they're in the same directory. What should I do to make Doxygen notice my D files?
Related
GitHub search allows filtering repositories by language. How can I set a repository to a specific language?
You can also override certain files
$ cat .gitattributes
*.rb linguist-language=Java
Source
It is purely deduced from the code content.
As Pedro mentions:
Please note that we count the total bytes of each language's file (we check the extension) to decide the percentages.
This means that if you see your project reported a JavaScript, but you swear you use Ruby, you probably have a JS lib somewhere that is bigger than your Ruby code
As detailed in "GitHub changes repository to the wrong language", you can add a .gitattributes file in which you can:
ignore part of your project (not considered for language detection)
static/* linguist-vendored
consider part of your project as documentation:
docs/* linguist-documentation
indicate some files with specific extension (for instance *.rb) should be considered a specific language:
*.rb linguist-language=Java
You can also make some of the files vendor-ed. Just create a .gitattributes file in the main directory. If you want to exclude CSS from the language statistics write into the file something like this.
client/stylesheets/* linguist-vendored
This will hide all files in the client/stylesheets/ from the language statistics. In my case these are the .css files.
This solves your problem partly, because hides the most used language and choose the second one to be prime.
A bit brute-force, but I used this .gitattributes file:
* linguist-vendored
*.js linguist-vendored=false
It says to ignore all files except .js, so JavaScript becomes the only possible language. My project, https://github.com/aim12340/jQuery-Before-Ready, was listed as HTML and this changed it to JavaScript.
As VonC mentioned in the comments, you can put your libraries under "vendors" or "thirdparty" and the files won't be analysed by linguist, the tool GitHub uses to analyse the language in your code.
# Vendored dependencies
- third[-_]?party/
- 3rd[-_]?party/
- vendors?/
- extern(al)?/
Later, they added more folder names.
Create .gitattributes file in the root of your folder.
Suppose you want the language to be Java, just copy-paste
*.java linguist-detectable=true
*.js linguist-detectable=false
*.html linguist-detectable=false
*.xml linguist-detectable=false
in the .gitattributes file and push the file in the repository. Reload your GitHub page to see the language change.
For reference, use this GitHub repository.
Rename the name of the code files in your repository with the extension added.
For example:
change abc to abc.py for Python
abc to abc.java for Java files
abc to abc.html for HTML
I have a project that has hundreds of .c .h and .cpp files. I'd like to start using vscode with this project; however, I need to be able to tell vscode what files to actually include in the project (because depending on the build, many files are not included). Is there a way to force a file list into vscode without using the GUI/Add-File mechanism?
I have been working on my project and have done the documentation using the doxygen. Now I want to run the doxygen using the [doxygen doxygen.config] command on the windows terminal, but it says that the doxygen command is not found. I been used to using it in Linux and it seems to be so easy. I tried using doxygen wizard to generate the doxygen but it does not seem to work. Can someone tell me how to approach this issue?
I run the wizard with the doxygen file and it generates the "generated" folder in which there is the "html" and "later" folder. But there is nothing in the html folder.
In the plugins folder I see various languages and within those folders I see ticino.plugin.json file where file extensions are associated with the given plugin. However, PHP is not in this folder, and none of the ticino.plugin.json files have the PHP extension associated with them.
I do see in the client/vs/languages folder that there is php folder, but there is nothing that I can find that would allow me to associate the additional file extension.
I did similar, I cloned the c# plugin and renamed it, then added my extensions. Take a look, https://github.com/genecyber/connectiq-build
Our team has just moved from Netbeans to IntelliJ 9 Ultimate and need to know what files/folders should typically be excluded from source control as they are not "workstation portable", i.e.: they reference paths that only exist on one user's computer.
As far as I can tell, IntelliJ wants to ignore most of the .idea project including
.idea/artifacts/*
.idea/inspectionProfiles/*
.idea/copyright/*
.idea/dataSources.ids
.idea/dataSources.xml
.idea/workspace.xml
However, it seems to want to check in the .iml files that exist in each module's root directory.
I originally checked in the entire .idea directory via the command line which is obviously not aware of what "should" be ignored by IDEA. Is the entire .idea directory typically ignored?
We have a FAQ article covering this question.
[The .idea] format is used by all the recent IDE versions by default.
Here is what you need to share:
All the files under .idea directory in the project root except the workspace.xml and tasks.xml files which store user specific settings
All the .iml module files that can be located in different module directories (applies to IntelliJ IDEA)
Be careful about sharing the following:
Android artifacts that produce a signed build (will contain keystore passwords)
In IDEA 13 and earlier dataSources.ids, datasources.xml can contain database passwords. IDEA 14 solves this problem.
You may consider not to share the following:
.iml files for the Gradle or Maven based projects, since these files will be generated on import
gradle.xml file, see this discussion
user dictionaries folder (to avoid conflicts if other developer has the same name)
XML files under .idea/libraries in case they are generated from Gradle or Maven project
.idea directory is a replacement for the old .ipr (Idea Project) file and if you want to share the project between users, then you need to share .idea folder (with the exceptions mentioned in the FAQ) and all the .iml files.
Refer to GitHub's JetBrains.gitignore file to always have an updated listing of which files to ignore.
Not an exact answer to the question, but there are sample .gitignore files available here, including one for JetBrains which includes IntelliJ.
You might find this post interesting: Merges on IntelliJ IDEA .IPR and .IWS files
It seems to conclude that you should add all files except for: workspace.xml, dataSources.xml, sqlDataSources.xml and dynamic.xml. The answer there is focusing on having files that do not change simply from opening the editor or making ide specific changes.
I'm using PHPStorm.
Here is an example snippet for your .gitignore
# Ignore the following 2 PHPStorm files only workspace and tasks file
**/.idea/workspace.xml
**/.idea/tasks.xml
All other files in the .idea directory should be committed to your repository.
e.g: (commit everything else in the .idea directory)
new file: .idea/.name
new file: .idea/encodings.xml
new file: .idea/framework.iml
...
Docs: How to manage projects under Version Control Systems
Here is what you need to share:
All the files under .idea directory in the project root except the workspace.xml and tasks.xml files which store user specific settings
All the .iml module files that can be located in different module directories (applies to IntelliJ IDEA)
So basically, commit everything except workspace.xml and tasks.xml.
Yes, I believe so. You can check the SVN configuration to see what's ignored and add anything that you think should be ignored.
IntelliJ now creates its own .gitignore file in the .idea folder so you can safely add it to repository.