Skip to content

Commit f6e396f

Browse files
Unix69Unix69
committed
Specilizing better the EmbeddedDocsTemplate index.html page, for the specific example
1 parent c880f30 commit f6e396f

198 files changed

Lines changed: 1402 additions & 776 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎Doxyfile‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2755,6 +2755,12 @@ EXCLUDE = */tests/* */build/*
27552755
INPUT = ./ ./*.html ./Doxyfile ./Makefile ./*.sh ./*.md ./src *.js ./include
27562756
EXCLUDE = */tests/* */build/*
27572757
EXCLUDE = */tests/* */build/*
2758+
INPUT = ./ ./*.html ./Doxyfile ./Makefile ./*.sh ./*.md ./src *.js ./include
2759+
EXCLUDE = */tests/* */build/*
2760+
EXCLUDE = */tests/* */build/*
2761+
INPUT = ./ ./*.html ./Doxyfile ./Makefile ./*.sh ./*.md ./src *.js ./include
2762+
EXCLUDE = */tests/* */build/*
2763+
EXCLUDE = */tests/* */build/*
27582764
INPUT_ENCODING = UTF-8
27592765
EXCLUDE_SYMLINKS = YES
27602766
EXCLUDE_PATTERNS = *_tmp_*

‎Images/Logo/c-language.svg‎

Lines changed: 82 additions & 0 deletions
Loading

‎Makefile‎

Lines changed: 40 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,47 @@
1-
# Makefile for building Doxygen documentation
1+
# Makefile for building Doxygen documentation and C_Linux
22

33
# Variables
44
DOXYGEN_SH = ./doxygen.sh
55
DOXYFILE = Doxyfile
66
DOCS_DIR = docs
77
OUTDIR = docs/html
8+
CC = gcc
9+
CFLAGS = -Wall -O2
10+
SRC_DIR = src
11+
12+
# Find all .c files in src subfolders
13+
SRCS := $(shell find $(SRC_DIR) -name "*.c")
14+
OBJS := $(SRCS:.c=.o)
15+
16+
# Find all subfolders in src
17+
SUBDIRS := $(shell find $(SRC_DIR) -mindepth 1 -type d)
818

919
# Default target
10-
all:
11-
@echo "Use 'make build' 'make doc' to build README Template and generate the documentation for your code!"
20+
all: build doc link_all
21+
22+
# Build .o files for all .c files
23+
build: $(OBJS)
24+
@echo "==> Build of object files completed."
25+
26+
# Link all .o in each folder to one executable named as the folder
27+
link_all: $(SUBDIRS)
28+
@echo "==> Linking completed for all subfolders."
1229

13-
# Build Documentation target
14-
build:
30+
$(SUBDIRS):
31+
@echo "Linking objects in $@..."
32+
@OBJS_IN_DIR=$$(find $@ -maxdepth 1 -name "*.o"); \
33+
if [ ! -z "$$OBJS_IN_DIR" ]; then \
34+
$(CC) $(CFLAGS) $$OBJS_IN_DIR -o $@; \
35+
echo "Executable created: $@"; \
36+
fi
37+
38+
# Pattern rule to build .o from .c
39+
%.o: %.c
40+
@echo "Compiling $<..."
41+
$(CC) $(CFLAGS) -c $< -o $@
42+
43+
# Build Documentation target (Doxygen setup script)
44+
doc_build:
1545
@echo "==> Running Doxygen setup script..."
1646
@$(DOXYGEN_SH)
1747

@@ -24,9 +54,12 @@ doc:
2454
@cp -R Images $(OUTDIR) 2>/dev/null || true
2555
@echo "==> Copy completed."
2656

27-
2857
# Clean target
2958
clean:
59+
@echo "==> Removing object files in src..."
60+
@find $(SRC_DIR) -name "*.o" -type f -exec rm -f {} \;
61+
@echo "==> Removing executables in src..."
62+
@find $(SRC_DIR) -mindepth 1 -type f ! -name "*.c" ! -name "*.txt" ! -name "*.h" ! -name "*.hpp" -executable -exec rm -f {} \;
3063
@echo "==> Removing documentation output directory..."
3164
@rm -rf $(DOCS_DIR)
32-
@echo "==> Clean completed."
65+
@echo "==> Clean completed."

‎directory-tree.js‎

Lines changed: 146 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,152 @@ function initDirectoryTree(containerId) {
7979
{ type: "file", name: "header.html", icon: "📄", link: basePath + "header.html", preview: true },
8080
{ type: "file", name: "footer.html", icon: "📄", link: basePath + "footer.html", preview: true },
8181
{ type: "file", name: "index.html", icon: "📄", link: basePath + "index.html", preview: true },
82-
{ type: "folder", name: "src", icon: "📁", children: [] }
82+
{type:"folder", name:"src", icon:"📁",
83+
children:[
84+
85+
{ type:"folder", name:"C-Func-pointer",
86+
children:[
87+
{ type:"file", name:"main.c", link:basePath+"src/C-Func-pointer/main.c", preview:true }
88+
]
89+
},
90+
91+
{ type:"folder", name:"C-STD-File",
92+
children:[
93+
{ type:"file", name:"main.c", link:basePath+"src/C-STD-File/main.c", preview:true },
94+
{ type:"file", name:"file1.txt", link:basePath+"src/C-STD-File/file1.txt", preview:true },
95+
{ type:"file", name:"file2.txt", link:basePath+"src/C-STD-File/file2.txt", preview:true }
96+
]
97+
},
98+
99+
{ type:"folder", name:"C-Unix-STD-Basic-Fork",
100+
children:[
101+
{ type:"file", name:"main.c", link:basePath+"src/C-Unix-STD-Basic-Fork/main.c", preview:true }
102+
]
103+
},
104+
105+
{ type:"folder", name:"C-Unix-STD-Copy-DirectoryTree",
106+
children:[
107+
{ type:"file", name:"main.c", link:basePath+"src/C-Unix-STD-Copy-DirectoryTree/main.c", preview:true }
108+
]
109+
},
110+
111+
{ type:"folder", name:"C-Unix-STD-Execl",
112+
children:[
113+
{ type:"file", name:"main.c", link:basePath+"src/C-Unix-STD-Execl/main.c", preview:true }
114+
]
115+
},
116+
117+
{ type:"folder", name:"C-Unix-STD-Execlp-System",
118+
children:[
119+
{ type:"file", name:"main.c", link:basePath+"src/C-Unix-STD-Execlp-System/main.c", preview:true }
120+
]
121+
},
122+
123+
{ type:"folder", name:"C-Unix-STD-Explore-File-Directories",
124+
children:[
125+
{ type:"file", name:"main.c", link:basePath+"src/C-Unix-STD-Explore-File-Directories/main.c", preview:true }
126+
]
127+
},
128+
129+
{ type:"folder", name:"C-Unix-STD-Fork",
130+
children:[
131+
{ type:"file", name:"main.c", link:basePath+"src/C-Unix-STD-Fork/main.c", preview:true }
132+
]
133+
},
134+
135+
{ type:"folder", name:"C-Unix-STD-Fork-Sleep",
136+
children:[
137+
{ type:"file", name:"main.c", link:basePath+"src/C-Unix-STD-Fork-Sleep/main.c", preview:true }
138+
]
139+
},
140+
141+
{ type:"folder", name:"C-Unix-STD-Fork-Wait",
142+
children:[
143+
{ type:"file", name:"main.c", link:basePath+"src/C-Unix-STD-Fork-Wait/main.c", preview:true }
144+
]
145+
},
146+
147+
{ type:"folder", name:"C-Unix-STD-Fork-WaitPid",
148+
children:[
149+
{ type:"file", name:"main.c", link:basePath+"src/C-Unix-STD-Fork-WaitPid/main.c", preview:true }
150+
]
151+
},
152+
153+
{ type:"folder", name:"C-Unix-STD-Fork-Wait-Precedence",
154+
children:[
155+
{ type:"file", name:"main.c", link:basePath+"src/C-Unix-STD-Fork-Wait-Precedence/main.c", preview:true }
156+
]
157+
},
158+
159+
{ type:"folder", name:"C-Unix-STD-Kill",
160+
children:[
161+
{ type:"file", name:"main.c", link:basePath+"src/C-Unix-STD-Kill/main.c", preview:true }
162+
]
163+
},
164+
165+
{ type:"folder", name:"C-Unix-STD-Signal",
166+
children:[
167+
{ type:"file", name:"main.c", link:basePath+"src/C-Unix-STD-Signal/main.c", preview:true }
168+
]
169+
},
170+
171+
{ type:"folder", name:"C-Unix-STD-Signal-Fork",
172+
children:[
173+
{ type:"file", name:"main.c", link:basePath+"src/C-Unix-STD-Signal-Fork/main.c", preview:true }
174+
]
175+
},
176+
177+
{ type:"folder", name:"C-Unix-STD-Signal-Fork-Kill",
178+
children:[
179+
{ type:"file", name:"main.c", link:basePath+"src/C-Unix-STD-Signal-Fork-Kill/main.c", preview:true }
180+
]
181+
},
182+
{ type:"folder", name:"C-Unix-STD-Signal-Fork-Pause",
183+
children:[
184+
{ type:"file", name:"main.c", link:basePath+"src/C-Unix-STD-Signal-Fork-Pause/main.c", preview:true },
185+
{ type:"file", name:"son1.txt", link:basePath+"src/C-Unix-STD-Signal-Fork-Pause/son1.txt", preview:true },
186+
{ type:"file", name:"son2.txt", link:basePath+"src/C-Unix-STD-Signal-Fork-Pause/son2.txt", preview:true }
187+
]
188+
},
189+
{ type:"folder", name:"C-Unix-STD-Signal-Fork-Pause-Kill",
190+
children:[
191+
{ type:"file", name:"main.c", link:basePath+"src/C-Unix-STD-Signal-Fork-Pause-Kill/main.c", preview:true }
192+
]
193+
},
194+
{ type:"folder", name:"C-Unix-STD-Signal-Fork-Pause-Kill-File-Wait",
195+
children:[
196+
{ type:"file", name:"main.c", link:basePath+"src/C-Unix-STD-Signal-Fork-Pause-Kill-File-Wait/main.c", preview:true },
197+
{ type:"file", name:"testo_1.txt", link:basePath+"src/C-Unix-STD-Signal-Fork-Pause-Kill-File-Wait/testo_1.txt", preview:true },
198+
{ type:"file", name:"testo_3.txt", link:basePath+"src/C-Unix-STD-Signal-Fork-Pause-Kill-File-Wait/testo_3.txt", preview:true }
199+
]
200+
},
201+
{ type:"folder", name:"C-Unix-STD-Signal-Fork-Pause-Kill-Pipe",
202+
children:[
203+
{ type:"file", name:"main.c", link:basePath+"src/C-Unix-STD-Signal-Fork-Pause-Kill-Pipe/main.c", preview:true },
204+
{ type:"file", name:"testo.txt", link:basePath+"src/C-Unix-STD-Signal-Fork-Pause-Kill-Pipe/testo.txt", preview:true }
205+
]
206+
},
207+
{ type:"folder", name:"C-Unix-STD-Signal-Fork-Pause-Kill-Wait",
208+
children:[
209+
{ type:"file", name:"main.c", link:basePath+"src/C-Unix-STD-Signal-Fork-Pause-Kill-Wait/main.c", preview:true }
210+
]
211+
},
212+
{ type:"folder", name:"C-Unix-STD-Threads",
213+
children:[
214+
{ type:"file", name:"main.c", link:basePath+"src/C-Unix-STD-Threads/main.c", preview:true }
215+
]
216+
},
217+
{ type:"folder", name:"C-Unix-STD-Threads-Files-Assert",
218+
children:[
219+
{ type:"file", name:"main.c", link:basePath+"src/C-Unix-STD-Threads-Files-Assert/main.c", preview:true },
220+
{ type:"file", name:"file1in.txt", link:basePath+"src/C-Unix-STD-Threads-Files-Assert/file1in.txt", preview:true },
221+
{ type:"file", name:"file1out.txt", link:basePath+"src/C-Unix-STD-Threads-Files-Assert/file1out.txt", preview:true },
222+
{ type:"file", name:"file2in.txt", link:basePath+"src/C-Unix-STD-Threads-Files-Assert/file2in.txt", preview:true },
223+
{ type:"file", name:"file2out.txt", link:basePath+"src/C-Unix-STD-Threads-Files-Assert/file2out.txt", preview:true },
224+
{ type:"file", name:"file3in.txt", link:basePath+"src/C-Unix-STD-Threads-Files-Assert/file3in.txt", preview:true },
225+
{ type:"file", name:"file3out.txt", link:basePath+"src/C-Unix-STD-Threads-Files-Assert/file3out.txt", preview:true }
226+
]
227+
}]}
83228
];
84229

85230
function createTree(data) {

‎docs/doxygen_warnings.log‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
warning: source examples is not a readable file or directory... skipping.
2+
warning: source ./*.html is not a readable file or directory... skipping.
3+
warning: source ./*.sh is not a readable file or directory... skipping.
4+
warning: source ./*.md is not a readable file or directory... skipping.
5+
warning: source *.js is not a readable file or directory... skipping.
6+
warning: source ./include is not a readable file or directory... skipping.
7+
/home/giuseppe/Documents/Programming/Repositories/C_Linux/CONTACT_US.md:39: warning: Illegal </br> tag found
8+
9+
/home/giuseppe/Documents/Programming/Repositories/C_Linux/CONTACT_US.md:40: warning: Illegal </br> tag found
10+
11+
/home/giuseppe/Documents/Programming/Repositories/C_Linux/CONTACT_US.md:41: warning: Illegal </br> tag found
12+
13+
/home/giuseppe/Documents/Programming/Repositories/C_Linux/README.md:414: warning: explicit link request to 'create' could not be resolved
14+
/home/giuseppe/Documents/Programming/Repositories/C_Linux/README.md:415: warning: explicit link request to 'change' could not be resolved
15+
/home/giuseppe/Documents/Programming/Repositories/C_Linux/README.md:416: warning: explicit link request to 'make' could not be resolved
16+
/home/giuseppe/Documents/Programming/Repositories/C_Linux/README.md:417: warning: explicit link request to 'unzip' could not be resolved
17+
/home/giuseppe/Documents/Programming/Repositories/C_Linux/README.md:418: warning: explicit link request to 'copy' could not be resolved
18+
/home/giuseppe/Documents/Programming/Repositories/C_Linux/README.md:419: warning: explicit link request to 'remove' could not be resolved
19+
/home/giuseppe/Documents/Programming/Repositories/C_Linux/README.md:425: warning: explicit link request to 'create' could not be resolved
20+
/home/giuseppe/Documents/Programming/Repositories/C_Linux/README.md:426: warning: explicit link request to 'change' could not be resolved
21+
/home/giuseppe/Documents/Programming/Repositories/C_Linux/README.md:427: warning: explicit link request to 'clone' could not be resolved
22+
/home/giuseppe/Documents/Programming/Repositories/C_Linux/README.md:428: warning: explicit link request to 'copy' could not be resolved
23+
/home/giuseppe/Documents/Programming/Repositories/C_Linux/README.md:429: warning: explicit link request to 'remove' could not be resolved
24+
/home/giuseppe/Documents/Programming/Repositories/C_Linux/README.md:510: warning: Found unknown command '\echo'
25+
/home/giuseppe/Documents/Programming/Repositories/C_Linux/README.md:514: warning: Found unknown command '\echo'
26+
/home/giuseppe/Documents/Programming/Repositories/C_Linux/README.md:519: warning: Found unknown command '\echo'
27+
/home/giuseppe/Documents/Programming/Repositories/C_Linux/README.md:520: warning: Found unknown command '\doxygen'
28+
/home/giuseppe/Documents/Programming/Repositories/C_Linux/README.md:521: warning: Found unknown command '\echo'
29+
/home/giuseppe/Documents/Programming/Repositories/C_Linux/README.md:522: warning: Found unknown command '\echo'
30+
/home/giuseppe/Documents/Programming/Repositories/C_Linux/README.md:523: warning: Found unknown command '\cp'
31+
/home/giuseppe/Documents/Programming/Repositories/C_Linux/README.md:524: warning: Found unknown command '\echo'
32+
/home/giuseppe/Documents/Programming/Repositories/C_Linux/README.md:530: warning: Found unknown command '\echo'
33+
/home/giuseppe/Documents/Programming/Repositories/C_Linux/README.md:531: warning: Found unknown command '\rm'
34+
/home/giuseppe/Documents/Programming/Repositories/C_Linux/README.md:532: warning: Found unknown command '\echo'
35+
/home/giuseppe/Documents/Programming/Repositories/C_Linux/README.md:878: warning: Unexpected html tag <br> found within <a href=...> context
36+
/home/giuseppe/Documents/Programming/Repositories/C_Linux/README.md:906: warning: found </div> tag without matching <div>

0 commit comments

Comments
 (0)